handover/.github/workflows/docs-deploy.yml at main · farce1/handover · 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
name: Docs Deploy

on:
  push:
    branches: [main]
    paths:
      - 'docs/**'
      - 'README.md'
      - 'package.json'
      - 'package-lock.json'
      - 'CHANGELOG.md'
      - 'src/cli/index.ts'
      - 'scripts/**'
      - '.github/workflows/docs-deploy.yml'
  workflow_dispatch:

concurrency:
  group: docs-deploy-${{ github.ref }}
  cancel-in-progress: true

permissions: read-all

jobs:
  build:
    name: Build docs site
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 22
          cache: npm

      - name: Install dependencies
        run: npm ci

      - name: Generate docs artifacts
        run: npm run docs:generate

      - name: Build docs
        run: npm run docs:build

      - name: Prepare docs artifact
        run: |
          touch docs/dist/.nojekyll

      - name: Setup Pages
        uses: actions/configure-pages@v6

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: docs/dist

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