This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release | ||
| on: | ||
| 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_docs: | ||
| name: Build Docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout Repo | ||
| uses: actions/checkout@v3 | ||
| - name: Setup Node.js 18.x | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 18 | ||
| - name: Install Dependencies | ||
| run: yarn | ||
| - name: Create Docs | ||
| run: npx typedoc | ||
| - name: "Upload Pages artifact" | ||
| uses: "actions/upload-pages-artifact@v4" | ||
| with: | ||
| path: "docs/" | ||
| # Deployment job | ||
| deploy: | ||
| name: Deploy Docs to Github Pages | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build_docs | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
| - id: "deployment" | ||
| name: "Deploy documentation to GitHub Pages" | ||
| uses: "actions/deploy-pages@v2" | ||
