Repository navigation
55 lines (51 loc) · 1.67 KB
/
Copy pathdocs-updates.yml
File metadata and controls
55 lines (51 loc) · 1.67 KB
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
name: Documentation release check
on:
schedule:
- cron: "17 7 * * *"
workflow_dispatch:
push:
branches: [main]
paths:
- tools.json
- authored-docs.json
- scripts/docs-freshness.ts
- scripts/docs-updates.ts
- scripts/docs-contracts.ts
- .github/workflows/docs-updates.yml
permissions:
contents: read
issues: write
concurrency:
group: documentation-release-check
cancel-in-progress: false
jobs:
check-releases:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
- uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: 24
cache: pnpm
- run: pnpm install --frozen-lockfile
# The site's commands are checked against each newer npm release, so the pages must exist.
- run: pnpm sync
continue-on-error: true
- name: Compare published releases and maintain a review issue
run: pnpm docs:updates --notify
env:
GH_TOKEN: ${{ github.token }}
GITHUB_REPOSITORY: ${{ github.repository }}
- name: Report which tool docs lag npm, including hand-written guides
continue-on-error: true
shell: bash
run: pnpm --silent docs:freshness | tee -a "$GITHUB_STEP_SUMMARY"
- name: Write the review report to the run summary
if: always()
run: |
if [ -f .docs-updates/report.md ]; then
cat .docs-updates/report.md >> "$GITHUB_STEP_SUMMARY"
fi