DCSOlympus/.github/workflows/documentation.yml
2023-12-13 16:37:37 +01:00

43 lines
1020 B
YAML

# ci.yml file for GitHub Actions
name: Documentation
on: [push]
# 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: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v2
- name: Install dependencies
run: npm ci
working-directory: ./client
- name: Create the docs directory locally in CI
run: npx typedoc --out ../docs/client @types/*.d.ts src/**/*.ts
working-directory: ./client
- name: Install Doxygen
run: sudo apt-get install doxygen -y
shell: bash
- name: Generate Doxygen Documentation
run: doxygen docs
shell: bash
working-directory: ./src
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs