ci: enhance docs publishing workflow #521
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 to GitHub Pages | |
| on: | |
| workflow_dispatch: | |
| push: | |
| paths: | |
| - 'docs/**' | |
| - '.github/workflows/publish-docs.yaml' | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| pull-requests: write | |
| # Allow only one concurrent deployment | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| jobs: | |
| build-and-deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: ${{ github.ref == 'refs/heads/main' && 'github-pages' || 'preview' }} | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| cache: npm | |
| cache-dependency-path: docs/package-lock.json | |
| - name: Build docs | |
| working-directory: docs | |
| run: | | |
| npm ci | |
| npm run build | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Upload Pages artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: docs/build | |
| name: github-pages | |
| - name: Deploy | |
| id: deployment | |
| if: | | |
| github.ref == 'refs/heads/main' || | |
| github.ref == 'refs/heads/docs-test' || | |
| startsWith(github.ref, 'refs/heads/docs/') | |
| uses: actions/deploy-pages@v4 | |
| with: | |
| artifact_name: github-pages | |
| preview: ${{ github.ref != 'refs/heads/main' }} | |
| - name: Comment PR | |
| if: | | |
| github.event_name == 'pull_request' && | |
| (github.ref == 'refs/heads/docs-test' || | |
| startsWith(github.ref, 'refs/heads/docs/')) | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| const url = '${{ steps.deployment.outputs.page_url }}'; | |
| const message = `📚 Documentation preview available at: ${url}`; | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: message | |
| }); |