openscreen/.github/workflows/docs.yml at main · getopenscreen/openscreen · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
name: Docs

on:
  pull_request:
    branches: [main]
    paths:
      - "website/**"
      - ".github/workflows/docs.yml"
  push:
    branches: [main]
    paths:
      - "website/**"
      - ".github/workflows/docs.yml"
  # The /download page resolves the current release's assets at build time so it
  # can link each platform to its actual file. Without a post-release rebuild that
  # data would freeze at whatever the last website/** change saw, and the page
  # would keep serving the previous version's binaries after every release.
  #
  # That rebuild is a `workflow_dispatch` fired by build.yml once the release is
  # published, NOT an `on: release` trigger. A release event runs with
  # github.ref = refs/tags/vX.Y.Z, and the github-pages environment only allows
  # `main` to deploy, so the deploy job failed on every stable release (it never
  # surfaced earlier because pre-releases skipped the build entirely). Dispatching
  # against main both satisfies that policy and publishes main's docs rather than
  # the release branch's older snapshot.
  workflow_dispatch:

# Cancel in-flight runs on the same ref so fast follow-up pushes
# don't queue stale builds.
concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  build:
    name: Build site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
        with:
          persist-credentials: false
      - uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
        with:
          node-version: 22
          cache: npm
          cache-dependency-path: website/package-lock.json
      - name: Install dependencies
        working-directory: website
        run: npm ci
      - name: Type-check
        working-directory: website
        run: npm run typecheck
      - name: Build
        working-directory: website
        run: npm run build
      - name: Upload artifact
        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1
        with:
          path: website/build

  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    needs: build
    if: >-
      (github.event_name == 'push' && github.ref == 'refs/heads/main')
      || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main')
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write
    steps:
      - id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5