Ci/generate deploy typedoc #2
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: Generate and Deploy Typedoc | |
| on: | |
| pull_request: | |
| branches: | |
| - main # Adjust this to your project's default branch if different | |
| types: [opened, synchronize] | |
| jobs: | |
| generate_and_deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '18.17.1' | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Generate Typedoc | |
| run: npm run build:typedoc # Adjust the paths as necessary | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs # Adjust the folder name as necessary |