Workflow file for this run
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: Deploy TypeDoc on GitHub pages | |
| on: | |
| workflow_dispatch: | |
| release: | |
| types: [published] | |
| env: | |
| NODE_VERSION: 20.x | |
| ENTRY_FILE: 'src/index.ts' | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Build documentation | |
| uses: zakodium/typedoc-action@v2 | |
| with: | |
| entry: ${{ env.ENTRY_FILE }} | |
| - name: Deploy to GitHub pages | |
| uses: JamesIves/github-pages-deploy-action@releases/v4 | |
| with: | |
| token: ${{ secrets.BOT_TOKEN }} | |
| branch: gh-pages | |
| folder: docs | |
| clean: true |