rawsql-ts/.github/workflows/docs.yml at main · mk3008/rawsql-ts · 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
86
87
88
89
90
91
92
93
94
95
name: Docs

on:
  push:
    branches: [ main ]
    paths:
      - 'docs/**'
      - '!docs/api/**'
      - 'packages/core/src/**'
      - 'packages/ddl-docs-cli/**'
      - 'packages/transfer/db/ddl/**'
      - 'packages/transfer/docs/**'
      - 'scripts/generate-transfer-docs.mjs'
      - 'typedoc.json'
      - 'package.json'
      - 'pnpm-lock.yaml'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

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

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

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          persist-credentials: true

      - name: Setup pnpm
        uses: pnpm/action-setup@v4
        with:
          run_install: false

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'pnpm'

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Build workspace packages
        run: |
          pnpm --filter rawsql-ts run build
          pnpm --filter @rawsql-ts/testkit-core run build

      - name: Verify transfer docs and metadata drift
        run: pnpm run verify:transfer-docs

      - name: Build documentation
        run: pnpm run docs:build

      - name: Commit generated API docs
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          git config --local user.name "GitHub Actions"
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git add docs/api
          if git diff --cached --quiet; then
            echo "docs/api is already up to date"
            exit 0
          fi
          git commit --no-verify -m "docs: refresh API reference [skip ci]"
          if git push; then
            echo "docs: pushed API reference updates"
          else
            echo "docs: failed to push API reference updates; please push manually if needed" >&2
          fi

      - name: Upload static site
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/.vitepress/dist

  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@v4