dispatch/.github/workflows/deploy-docs.yml at main · Jamyn/dispatch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
name: Deploy docs

# Builds the Docusaurus site in docs/ and publishes it via the GitHub Pages
# deployment API, served at https://jamyn.github.io/dispatch/. No gh-pages
# branch or git commit is involved, so the repo-wide required-signatures
# ruleset (which a git-pushed gh-pages commit can never satisfy) doesn't apply.
on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/deploy-docs.yml"
  workflow_dispatch:

concurrency:
  group: pages
  cancel-in-progress: false

permissions:
  contents: read

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          # Matches the node npm-lock-sync validates against, so the tree that
          # deploys is the tree that gate approved.
          node-version: 22
          cache: npm
          cache-dependency-path: docs/package-lock.json
      - name: Install and build
        working-directory: docs
        run: |
          # ci, not install: install may re-resolve and rewrite the lockfile, so
          # a floated transitive can reach production unreviewed. A webpack that
          # drifts past 5.94.0 fails Docusaurus 2.4.0's ProgressPlugin schema.
          npm ci
          npm run build
      - uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
        with:
          path: docs/build

  deploy:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0