Documentation delivery to GitHub Pages #9
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: Documentation delivery to GitHub Pages | |
| on: | |
| workflow_run: | |
| workflows: [ Continuous integration ] | |
| types: [ completed ] | |
| branches: [ main ] | |
| schedule: | |
| - cron: 0 7 1 * * # at 07:00 on day-of-month 1, UTC | |
| workflow_dispatch: | |
| inputs: | |
| reason: | |
| description: The reason for dispatching it manually. | |
| type: string | |
| default: manual healthcheck | |
| required: true | |
| concurrency: | |
| group: ghp-pages | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Building | |
| runs-on: ubuntu-latest | |
| if: ${{ contains(fromJSON('[null, "success"]'), github.event.workflow_run.conclusion) }} | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/[email protected] | |
| with: { fetch-depth: 0 } | |
| - name: Set up Node.js environment | |
| uses: actions/[email protected] | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| cache-dependency-path: docs/package-lock.json | |
| check-latest: true | |
| - name: Install dependencies | |
| run: ./Taskfile docs npm ci | |
| - name: Set up GitHub Pages | |
| uses: actions/[email protected] | |
| - name: Build documentation | |
| run: ./Taskfile docs publish | |
| - name: Upload documentation | |
| uses: actions/[email protected] | |
| with: { path: docs/dist } | |
| deploy: | |
| name: Deploying | |
| needs: [ build ] | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| contents: read | |
| id-token: write | |
| pages: write | |
| steps: | |
| - name: Deploy it to GitHub Pages | |
| id: deployment | |
| uses: actions/[email protected] | |
| notify: | |
| name: Notifying | |
| needs: [ build, deploy ] | |
| runs-on: ubuntu-latest | |
| if: failure() || success() | |
| steps: | |
| - name: Checkout the repository | |
| uses: actions/[email protected] | |
| with: { fetch-depth: 0 } | |
| - name: Send notification | |
| uses: ./.github/actions/notify | |
| with: | |
| emoji: 📚 | |
| channel: ${{ secrets.SLACK_WEBHOOK }} | |
| success: ${{ ! contains(needs.*.result, 'failure') }} |