Docs #30
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
| # This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node | |
| # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs | |
| name: Docs | |
| on: | |
| workflow_run: | |
| workflows: [CI] | |
| types: [completed] | |
| # 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: | |
| on-success: | |
| runs-on: ubuntu-latest | |
| environment: github-pages | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "20.x" | |
| - run: npm ci | |
| - run: npm run build | |
| - run: npm run api-report | |
| - run: npm run docs | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Build Pages | |
| uses: actions/jekyll-build-pages@v1 | |
| with: | |
| source: "./docs" | |
| destination: "./_site" | |
| - name: Upload Artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: "./_site" | |
| - uses: actions/deploy-pages@v3 |