2024-11-07 21:48:10 +03:00
|
|
|
name: Deploy docs to Github Pages
|
|
|
|
|
|
|
|
on:
|
|
|
|
# Runs on pushes targeting the default branch
|
|
|
|
push:
|
|
|
|
branches:
|
|
|
|
- main
|
|
|
|
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
|
|
workflow_dispatch:
|
|
|
|
|
|
|
|
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
|
|
|
permissions:
|
|
|
|
contents: read
|
|
|
|
pages: write
|
|
|
|
id-token: write
|
|
|
|
|
|
|
|
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
|
|
|
|
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
|
|
|
|
concurrency:
|
|
|
|
group: "pages"
|
|
|
|
cancel-in-progress: false
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
build:
|
|
|
|
name: Build
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
|
|
- name: Checkout
|
|
|
|
uses: actions/checkout@v4
|
|
|
|
|
|
|
|
- name: Setup Node
|
|
|
|
uses: actions/setup-node@v4
|
|
|
|
with:
|
|
|
|
node-version: "20"
|
2025-02-20 16:33:35 +03:00
|
|
|
cache: npm
|
|
|
|
cache-dependency-path: ./package-lock.json
|
2024-11-07 21:48:10 +03:00
|
|
|
|
|
|
|
- name: Setup Pages
|
|
|
|
id: pages
|
|
|
|
uses: actions/configure-pages@v5
|
|
|
|
|
|
|
|
- name: Install dependencies
|
2025-02-20 16:33:35 +03:00
|
|
|
run: npm ci
|
2024-11-07 21:48:10 +03:00
|
|
|
|
|
|
|
- name: Install typedoc
|
2025-02-20 16:33:35 +03:00
|
|
|
run: npm install -D typedoc@0.26.11 typedoc-plugin-include-example@1.4.1
|
2024-11-07 21:48:10 +03:00
|
|
|
|
|
|
|
- name: Build
|
2025-02-20 16:33:35 +03:00
|
|
|
run: npx typedoc
|
2024-11-07 21:48:10 +03:00
|
|
|
|
|
|
|
- name: Upload artifact
|
|
|
|
uses: actions/upload-pages-artifact@v3
|
|
|
|
with:
|
2024-11-10 19:34:04 +03:00
|
|
|
path: ./docs/html
|
2024-11-07 21:48:10 +03:00
|
|
|
|
|
|
|
deploy:
|
|
|
|
environment:
|
|
|
|
name: github-pages
|
|
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
|
|
needs: build
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
name: Deploy
|
|
|
|
steps:
|
|
|
|
- name: Deploy to GitHub Pages
|
|
|
|
id: deployment
|
|
|
|
uses: actions/deploy-pages@v4
|