docs/.github/workflows/docs-ci.yml at 94bf6f72f4d413b2d2b392aec550f3e80bfdf37d · HagiCode-org/docs · 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
name: Docs CI

on:
  push:
    branches:
      - main
  pull_request:
    types: [opened, synchronize, reopened]
    branches:
      - main

concurrency:
  group: docs-ci-${{ github.event_name }}-${{ github.head_ref || github.ref_name }}
  cancel-in-progress: true

jobs:
  build_and_verify:
    runs-on: ubuntu-latest
    name: Build and Verify Docs
    permissions:
      contents: read
    env:
      NODE_VERSION: "22"
      DOCS_LINK_CHECK_CACHE_DIR: .tmp/link-check-cache
      DOCS_LINK_CHECK_CACHE_SCOPE: ${{ github.head_ref || github.ref_name }}
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}
          cache: "npm"

      - name: Install dependencies
        run: npm ci

      - name: Restore docs link-check cache
        id: docs-link-check-cache-restore
        uses: actions/cache/restore@v4
        with:
          path: ${{ env.DOCS_LINK_CHECK_CACHE_DIR }}
          key: docs-link-check-${{ runner.os }}-${{ env.DOCS_LINK_CHECK_CACHE_SCOPE }}-${{ github.sha }}
          restore-keys: |
            docs-link-check-${{ runner.os }}-${{ env.DOCS_LINK_CHECK_CACHE_SCOPE }}-

      - name: Build and verify docs
        run: npm run build:ci
        env:
          CLARITY_PROJECT_ID: ${{ secrets.CLARITY_PROJECT_ID }}

      - name: Save docs link-check cache
        if: always()
        uses: actions/cache/save@v4
        with:
          path: ${{ env.DOCS_LINK_CHECK_CACHE_DIR }}
          key: docs-link-check-${{ runner.os }}-${{ env.DOCS_LINK_CHECK_CACHE_SCOPE }}-${{ github.sha }}