Merge pull request #114 from ciatph/wip/dispatch #62
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: Build and Deploy Docs | |
| on: | |
| push: | |
| branches: | |
| - dev # Automatically trigger on pushes to the dev branch | |
| release: | |
| types: [published] # Automatically trigger on new releases | |
| workflow_dispatch: # Allows manual triggering of the workflow | |
| jobs: | |
| build-docs: | |
| name: Build Class Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/checkout@v4 | |
| - name: Use NodeJS v16.14.2 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 16.14.2 | |
| - name: Install jsdoc and build | |
| run: | | |
| chmod u+x scripts/docs-build-gh.sh && ./scripts/docs-build-gh.sh | |
| cd app && ./docs-install.sh | |
| npm run generate-docs | |
| - name: Archive Development Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| include-hidden-files: true | |
| path: app/docs/ | |
| retention-days: 3 | |
| deploy-docs: | |
| name: Deploy docs to Github Pages | |
| needs: build-docs | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/dev') | |
| steps: | |
| - name: Download Artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: docs | |
| - name: List files for publish | |
| run: ls -l -a | |
| - name: Deploy to Github Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./ | |
| publish_branch: gh-pages |