mirror of
https://github.com/Pax1601/DCSOlympus.git
synced 2025-10-29 16:56:34 +00:00
44 lines
1.0 KiB
YAML
44 lines
1.0 KiB
YAML
# ci.yml file for GitHub Actions
|
|
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
permissions:
|
|
contents: write
|
|
pages: write
|
|
id-token: write
|
|
|
|
jobs:
|
|
build_docs:
|
|
runs-on: windows-latest
|
|
steps:
|
|
- name: Checkout the repository
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v2
|
|
|
|
- name: Install dependencies
|
|
run: npm install
|
|
working-directory: ./frontend/website
|
|
|
|
- name: Create the docs directory locally in CI
|
|
run: npx typedoc --out ../../docs/website @types/*.d.ts src/**/*.ts
|
|
working-directory: ./frontend/website
|
|
|
|
- name: Install Doxygen
|
|
uses: ssciwr/doxygen-install@v1
|
|
|
|
- name: Generate Doxygen Documentation
|
|
run: doxygen docs
|
|
working-directory: ./src
|
|
|
|
- name: Deploy 🚀
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
|
with:
|
|
folder: docs
|