XLibur/.github/workflows/docs.yml at main · SamPlusPlus/XLibur · 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
80
81
82
83
name: Docs

on:
  push:
    branches: [main]
    paths:
      - 'docs-website/**'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [main]
    paths:
      - 'docs-website/**'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

# Allow one concurrent deployment; don't cancel an in-progress production deploy.
concurrency:
  group: pages-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

defaults:
  run:
    working-directory: docs-website

jobs:
  build:
    name: Build site
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      # Must precede setup-node: `cache: pnpm` needs the pnpm binary on PATH to
      # resolve the store path. The version comes from packageManager in package.json.
      - name: Setup pnpm
        uses: pnpm/action-setup@0977fd99725f1db4007ccb2928dbb4e90d06cc86 # v6.0.10
        with:
          # There is no root package.json — the field lives in the docs project.
          package_json_file: docs-website/package.json

      - name: Setup Node
        uses: actions/setup-node@v7
        with:
          node-version: 22
          cache: pnpm
          cache-dependency-path: docs-website/pnpm-lock.yaml

      - name: Install dependencies
        # No dependency needs a lifecycle script to build the site: only core-js
        # (a donation banner) and fsevents (macOS-only) declare one. pnpm 10 also
        # blocks dependency scripts by default, so this is belt and braces.
        run: pnpm install --frozen-lockfile --ignore-scripts

      - name: Type check
        run: pnpm run typecheck

      - name: Build
        run: pnpm run build

      - name: Upload Pages artifact
        # Only the production deploy needs the artifact; PRs just verify the build.
        if: github.event_name != 'pull_request'
        uses: actions/upload-pages-artifact@v5
        with:
          path: docs-website/build

  deploy:
    name: Deploy to GitHub Pages
    if: github.event_name != 'pull_request'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Configure Pages
        uses: actions/configure-pages@v6

      - name: Deploy
        id: deployment
        uses: actions/deploy-pages@v5