securitydept/.github/workflows/docs.yml at main · ethaxon/securitydept · 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
84
85
name: Docs

on:
    push:
        branches:
            - main
        paths:
            - "README.md"
            - "README_zh.md"
            - "LICENSE"
            - "LICENSE.md"
            - "docs/**"
            - "docsite/**"
            - "mise.toml"
            - "mise.ci.toml"
            - "rust-toolchain.toml"
            - "justfile"
            - ".github/workflows/docs.yml"
    workflow_dispatch:

permissions:
    contents: read
    pages: write
    id-token: write

concurrency:
    group: docs-pages
    cancel-in-progress: true

jobs:
    build:
        runs-on: ubuntu-latest
        steps:
            - name: Checkout repository
              uses: actions/checkout@v6

            - name: Setup mise
              uses: ./.github/actions/setup-mise-pnpm
              with:
                  working-directory: docsite
                  lockfile: docsite/pnpm-lock.yaml
                  cache-mode: read-write

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

            - name: Build VitePress site
              run: mise exec -C docsite --command "pnpm run build"

            - name: Upload Pages artifact
              uses: actions/upload-pages-artifact@v5
              with:
                  path: docsite/.vitepress/dist

            - name: Write docs workflow report
              shell: bash
              run: |
                  set -euo pipefail
                  mkdir -p temp/release/docs
                  cat > temp/release/docs/report.json <<EOF
                  {
                    "schemaVersion": 1,
                    "createdAt": "$(date -u +%Y-%m-%dT%H:%M:%SZ)",
                    "sourceRef": "${GITHUB_REF}",
                    "sourceSha": "${GITHUB_SHA}",
                    "artifact": "docsite/.vitepress/dist"
                  }
                  EOF

            - name: Upload docs workflow report
              uses: actions/upload-artifact@v7
              with:
                  name: docs-workflow-report
                  path: temp/release/docs/report.json

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