vercel-workflow-devkit/.github/workflows/docs-checks.yml at main · BunsDev/vercel-workflow-devkit · 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
name: Docs Checks

on:
  push:
    branches:
      - main
    tags:
      - "!*"
  pull_request:

concurrency:
  # Unique group for this workflow and branch
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

jobs:
  docs-typecheck:
    name: Docs Code Samples
    runs-on: ubuntu-latest
    timeout-minutes: 5
    env:
      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v4

      - name: Setup pnpm
        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0

      - name: Setup Node.js 22.x
        uses: actions/setup-node@v4
        with:
          node-version: 22.x
          cache: "pnpm"

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

      - name: Build packages
        run: pnpm build

      - name: Type-check documentation code samples
        run: pnpm test:docs

  docs-preview-smoke:
    name: Docs Preview Smoke Checks
    runs-on: ubuntu-latest
    # `changeset-release/*` PRs are not deployed (every project's vercel.json
    # sets `git.deploymentEnabled` false for that branch, because the branch is
    # force-pushed to main's HEAD SHA and a same-SHA preview deployment
    # clobbers the per-SHA Vercel commit status), so there is no preview to
    # smoke-test. Their docs content is identical to main's, which this job
    # already checked against production on the push that produced the bump.
    if: ${{ !startsWith(github.head_ref, 'changeset-release/') }}
    timeout-minutes: 5
    permissions:
      id-token: write
      contents: read
      deployments: read
      statuses: read
    env:
      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
    steps:
      - name: Checkout Repo
        uses: actions/checkout@v4

      - name: Setup pnpm
        uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0

      - name: Setup Node.js 22.x
        uses: actions/setup-node@v4
        with:
          node-version: 22.x
          cache: "pnpm"

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

      - name: Waiting for the Docs Vercel deployment
        id: waitForDocsDeployment
        uses: vercel/wait-for-deployment-action@0e2b0c5c5cce31f1648108aeec56467187aca037
        with:
          project-slug: workflow-docs
          timeout: 1000
          check-interval: 15
          environment: ${{ github.ref == 'refs/heads/main' && 'production' || 'preview' }}

      - name: Verify OpenGraph images and sitemap
        if: steps.waitForDocsDeployment.outputs.deployment-state == 'success'
        run: pnpm --filter docs test:smoke
        env:
          DEPLOYMENT_URL: ${{ steps.waitForDocsDeployment.outputs.deployment-url }}
          # Trusted-sources OIDC token is minted on demand by
          # scripts/trusted-sources-headers.mjs via the runner's
          # ACTIONS_ID_TOKEN_REQUEST_URL/_TOKEN env vars (auto-set when
          # `permissions: id-token: write` is on the job).
          # See: https://vercel.com/docs/deployment-protection/methods-to-bypass-deployment-protection/trusted-sources

      - name: Verify rendered docs links
        if: steps.waitForDocsDeployment.outputs.deployment-state == 'success'
        run: pnpm --filter docs lint:rendered-links
        env:
          DEPLOYMENT_URL: ${{ steps.waitForDocsDeployment.outputs.deployment-url }}
          # Trusted-sources OIDC token is minted on demand by
          # scripts/trusted-sources-headers.mjs via the runner's
          # ACTIONS_ID_TOKEN_REQUEST_URL/_TOKEN env vars (auto-set when
          # `permissions: id-token: write` is on the job).
          # See: https://vercel.com/docs/deployment-protection/methods-to-bypass-deployment-protection/trusted-sources