Create deploy.yml #1
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: "typedoc" | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| submodules: true | |
| - uses: actions/setup-node@v3 | |
| - run: npm ci | |
| # Generate your TypeDoc documentation | |
| - run: npx typedoc | |
| # https://github.com/actions/upload-pages-artifact | |
| - uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: ./docs # This should be your TypeDoc "out" path. | |
| deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| # https://github.com/actions/deploy-pages | |
| uses: actions/deploy-pages@v2 |