-
Notifications
You must be signed in to change notification settings - Fork 2
1450 lines (1354 loc) · 68.1 KB
/
upstream-release-docs.yml
File metadata and controls
1450 lines (1354 loc) · 68.1 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
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
name: Upstream Release Docs
# Reacts to Renovate-authored PRs that bump a `version:` in
# .github/upstream-projects.yaml. For all four tracked projects
# (toolhive, toolhive-registry-server, toolhive-studio,
# toolhive-cloud-ui), the flow is identical:
#
# 1. Renovate opens a version-bump PR
# 2. This workflow fires on the PR event, detects which project
# changed, shallow-clones the upstream at the new tag
# 3. Syncs declared upstream assets into static/ via sync-assets.mjs
# (release-asset downloads, tarball extractions, file-from-clone
# copies — see `assets:` in upstream-projects.yaml)
# 4. For toolhive specifically, downloads the CRD manifests tarball
# and runs extract-crd-schemas.mjs + generate-crd-pages.mjs +
# bundle-upstream-schema.mjs to produce our opinionated reference
# MDX (the CRD tarball and toolhive-core schemas are shipped as
# release assets by stacklok/toolhive#4982)
# 5. Runs two Claude Opus sessions: a generation pass running the
# upstream-release-docs skill, then a fresh-context editorial
# pass running docs-review over the changed files. Both have
# `gh` CLI access so they can fetch PR descriptions and linked
# issues for product context.
# 6. Auto-fixes prettier/eslint on the skill-touched files,
# commits everything to the PR branch, augments the PR body,
# assigns reviewers from non-bot release contributors
#
# Renovate is configured with rebaseWhen: never + recreateWhen: never
# so we can push commits without force-push races.
on:
pull_request:
types: [opened, reopened]
paths:
- '.github/upstream-projects.yaml'
workflow_dispatch:
inputs:
pr_number:
description: 'Retry-only: PR number to re-augment (must be an open Renovate PR). Leave blank to bootstrap a new PR via project_id + new_tag.'
required: false
type: string
project_id:
description: 'Bootstrap a new PR: id from .github/upstream-projects.yaml (e.g. toolhive-registry-server). Requires new_tag.'
required: false
type: string
new_tag:
description: 'Bootstrap a new PR: the upstream tag to document (e.g. v1.3.0). Requires project_id.'
required: false
type: string
permissions:
contents: write
pull-requests: write
# Required by anthropics/claude-code-action@v1 for OIDC token exchange.
id-token: write
concurrency:
# Workflow-level group so two simultaneous upstream releases don't
# run the skill in parallel on shared concept pages.
group: upstream-release-docs
cancel-in-progress: false
jobs:
augment:
runs-on: ubuntu-latest
timeout-minutes: 90
# Gate: two accepted entry points.
# - pull_request: Renovate-authored PR touching upstream-projects.yaml
# (the `paths:` filter on the trigger already narrows to YAML edits).
# - workflow_dispatch: human manually retries or bootstraps.
# Human-authored PRs that happen to edit the YAML are out of scope and
# should be reviewed normally without skill augmentation.
if: |
github.event_name == 'workflow_dispatch' ||
(
github.event_name == 'pull_request' &&
github.event.pull_request.user.login == 'renovate[bot]'
)
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Validate workflow_dispatch inputs
if: github.event_name == 'workflow_dispatch'
env:
PR_NUMBER_IN: ${{ github.event.inputs.pr_number }}
PROJECT_ID_IN: ${{ github.event.inputs.project_id }}
NEW_TAG_IN: ${{ github.event.inputs.new_tag }}
run: |
# Exactly one of: (pr_number) OR (project_id + new_tag).
if [ -n "$PR_NUMBER_IN" ] && { [ -n "$PROJECT_ID_IN" ] || [ -n "$NEW_TAG_IN" ]; }; then
echo "::error::Provide either pr_number (retry) or project_id + new_tag (bootstrap), not both."
exit 1
fi
if [ -z "$PR_NUMBER_IN" ] && { [ -z "$PROJECT_ID_IN" ] || [ -z "$NEW_TAG_IN" ]; }; then
echo "::error::Bootstrap mode requires both project_id and new_tag."
exit 1
fi
- name: Resolve PR number and head ref
id: pr
env:
EVENT: ${{ github.event_name }}
DISPATCH_PR: ${{ github.event.inputs.pr_number }}
PROJECT_ID_IN: ${{ github.event.inputs.project_id }}
NEW_TAG_IN: ${{ github.event.inputs.new_tag }}
EVENT_PR: ${{ github.event.pull_request.number }}
EVENT_HEAD_REF: ${{ github.event.pull_request.head.ref }}
run: |
case "$EVENT" in
pull_request)
PR_NUMBER="$EVENT_PR"
HEAD_REF="$EVENT_HEAD_REF"
MODE="react"
;;
workflow_dispatch)
if [ -n "$DISPATCH_PR" ]; then
PR_NUMBER="$DISPATCH_PR"
# --repo is required because this step runs before the
# actions/checkout below — gh otherwise looks for a
# local .git context and fails with "not a git repository".
HEAD_REF=$(gh pr view "$PR_NUMBER" --repo "$GITHUB_REPOSITORY" --json headRefName --jq .headRefName)
AUTHOR=$(gh pr view "$PR_NUMBER" --repo "$GITHUB_REPOSITORY" --json author --jq '.author.login')
case "$AUTHOR" in
app/renovate|renovate[bot]|app/github-actions|github-actions[bot])
;;
*)
echo "::error::PR #$PR_NUMBER author '$AUTHOR' is not an accepted bot. Retry mode accepts renovate[bot] or github-actions[bot]; use bootstrap (project_id + new_tag) for a fresh manual PR."
exit 1
;;
esac
MODE="retry"
else
# Bootstrap: branch and PR are created in the next step.
PR_NUMBER=""
HEAD_REF=""
MODE="bootstrap"
fi
;;
esac
{
echo "number=$PR_NUMBER"
echo "head_ref=$HEAD_REF"
echo "mode=$MODE"
} >> "$GITHUB_OUTPUT"
echo "Mode: $MODE"
# Bootstrap: a human manually dispatched with project_id + new_tag.
# Check out the dispatching branch (main in production; any branch
# for pre-merge testing — just dispatch via `gh workflow run --ref
# <branch>`), bump the YAML, create the PR, and emit its number +
# branch so the rest of the workflow proceeds as if Renovate had
# opened it.
- name: Checkout dispatching branch for bootstrap
if: steps.pr.outputs.mode == 'bootstrap'
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
ref: ${{ github.ref_name }}
fetch-depth: 0
- name: Setup (bootstrap)
if: steps.pr.outputs.mode == 'bootstrap'
uses: ./.github/actions/setup
- name: Set up Git (bootstrap)
if: steps.pr.outputs.mode == 'bootstrap'
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Bootstrap branch and PR
id: bootstrap
if: steps.pr.outputs.mode == 'bootstrap'
env:
PROJECT_ID: ${{ github.event.inputs.project_id }}
NEW_TAG: ${{ github.event.inputs.new_tag }}
BASE_REF: ${{ github.ref_name }}
ACTOR: ${{ github.actor }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
run: |
# Branch name intentionally distinct from Renovate's
# docs/upstream-<id> so the two paths don't collide.
BRANCH="manual/upstream-${PROJECT_ID}-${NEW_TAG}"
if git ls-remote --exit-code --heads origin "$BRANCH" >/dev/null 2>&1; then
echo "::error::Branch $BRANCH already exists on origin. Delete it or use retry mode with the existing PR's number."
exit 1
fi
git checkout -b "$BRANCH"
node scripts/upstream-release/bump-yaml.mjs \
--id "$PROJECT_ID" \
--tag "$NEW_TAG"
git add .github/upstream-projects.yaml
git commit -m "Bump $PROJECT_ID to $NEW_TAG"
git push origin "$BRANCH"
# Heredoc so the YAML indent doesn't leak into the PR body.
# Minimal placeholder -- the augmentation step below replaces
# content below its <!-- upstream-release-docs:start -->
# marker. Everything above the separator stays as the one-
# line context of who triggered the PR.
cat > /tmp/bootstrap-body.md <<EOF
Manually dispatched by @$ACTOR. [Workflow run]($RUN_URL).
EOF
sed -i 's/^ //' /tmp/bootstrap-body.md
# Opens as draft; the "Flip PR to ready for review" step at
# the end of the job flips it once the body has been augmented
# and reviewers assigned.
gh pr create \
--draft \
--base "$BASE_REF" \
--head "$BRANCH" \
--title "Update $PROJECT_ID to $NEW_TAG (manual dispatch)" \
--body-file /tmp/bootstrap-body.md
PR_NUMBER=$(gh pr view "$BRANCH" --json number --jq .number)
echo "number=$PR_NUMBER" >> "$GITHUB_OUTPUT"
echo "head_ref=$BRANCH" >> "$GITHUB_OUTPUT"
# Normalize the (possibly bootstrap-created) PR number, head_ref,
# and base_ref into a single step output so later steps reference
# one place. base_ref drives detect-change.mjs (the baseline to
# diff against) and the CRD-regen paths.
- name: Resolve effective PR metadata
id: eff
env:
EVENT: ${{ github.event_name }}
PR_FROM_RESOLVE: ${{ steps.pr.outputs.number }}
HEAD_FROM_RESOLVE: ${{ steps.pr.outputs.head_ref }}
PR_FROM_BOOTSTRAP: ${{ steps.bootstrap.outputs.number }}
HEAD_FROM_BOOTSTRAP: ${{ steps.bootstrap.outputs.head_ref }}
BASE_FROM_EVENT: ${{ github.event.pull_request.base.ref }}
DISPATCH_REF_NAME: ${{ github.ref_name }}
run: |
if [ -n "$PR_FROM_BOOTSTRAP" ]; then
# Bootstrap mode: the PR was just created with --base set to
# the dispatching branch (main in production; feat branch
# when testing pre-merge).
NUMBER="$PR_FROM_BOOTSTRAP"
HEAD="$HEAD_FROM_BOOTSTRAP"
BASE="$DISPATCH_REF_NAME"
elif [ "$EVENT" = "pull_request" ]; then
NUMBER="$PR_FROM_RESOLVE"
HEAD="$HEAD_FROM_RESOLVE"
BASE="$BASE_FROM_EVENT"
else
# workflow_dispatch retry: look up the PR's base_ref.
# --repo because in retry mode there's no prior checkout.
NUMBER="$PR_FROM_RESOLVE"
HEAD="$HEAD_FROM_RESOLVE"
BASE=$(gh pr view "$NUMBER" --repo "$GITHUB_REPOSITORY" --json baseRefName --jq .baseRefName)
fi
{
echo "number=$NUMBER"
echo "head_ref=$HEAD"
echo "base_ref=$BASE"
} >> "$GITHUB_OUTPUT"
# Flip the PR to draft for the duration of the augmentation job.
# A Renovate-opened PR arrives non-draft with the default bump-
# only body -- reviewers could approve / merge it before the
# skill has written any content. Bootstrap PRs are already
# --draft from the create call above, but we still run this for
# idempotency on workflow_dispatch retries. The "Flip PR to
# ready for review" step at the end reverses this once the body
# is augmented and reviewers are assigned.
# --repo is required on `gh pr view` / `gh pr ready` here because
# this step runs before the "Checkout PR branch" step below; gh
# otherwise looks for local .git context and fails with "not a
# git repository" on pull_request and workflow_dispatch retries.
# (Bootstrap has already checked out the dispatching branch, but
# the flag is harmless there and keeps this step path-agnostic.)
- name: Convert PR to draft
if: steps.eff.outputs.number != ''
env:
PR_NUMBER: ${{ steps.eff.outputs.number }}
run: |
IS_DRAFT=$(gh pr view "$PR_NUMBER" --repo "$GITHUB_REPOSITORY" --json isDraft --jq .isDraft)
if [ "$IS_DRAFT" = "false" ]; then
gh pr ready "$PR_NUMBER" --repo "$GITHUB_REPOSITORY" --undo
echo "Converted PR #$PR_NUMBER to draft."
else
echo "PR #$PR_NUMBER is already a draft; nothing to do."
fi
- name: Checkout PR branch
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
with:
ref: ${{ steps.eff.outputs.head_ref }}
fetch-depth: 0
# NOTE: we inline the node/deps setup rather than calling the
# ./.github/actions/setup composite because that composite starts
# with its own actions/checkout that overwrites the PR-branch
# checkout above with the dispatching branch.
- name: Set up Node.js
uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6
with:
node-version: '24.15.0'
- name: Cache dependencies
id: cache
uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
with:
path: ./node_modules
key: modules-${{ hashFiles('package-lock.json') }}
- name: Install dependencies
if: steps.cache.outputs.cache-hit != 'true'
run: npm ci
- name: Set up Git
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Detect changed project
id: detect
env:
# Pass the PR's actual base (main in production; dispatching
# branch when bootstrap was run via gh workflow run --ref).
BASE_REF: origin/${{ steps.eff.outputs.base_ref }}
run: node scripts/upstream-release/detect-change.mjs
- name: Verify prev_tag exists upstream
env:
REPO: ${{ steps.detect.outputs.repo }}
PREV_TAG: ${{ steps.detect.outputs.prev_tag }}
run: |
# Sanity check: if the pinned prev_tag doesn't exist upstream
# (e.g., a fake v0.0.0 seed, a retagged release, a deleted tag),
# fail early rather than let the skill produce a confusing diff.
if ! gh api "repos/$REPO/git/refs/tags/$PREV_TAG" --silent 2>/dev/null; then
echo "::error::prev_tag $PREV_TAG does not exist in $REPO. The pinned version in .github/upstream-projects.yaml may be wrong or the upstream tag was deleted. Fix the pinned version and re-run."
exit 1
fi
- name: Shallow-clone upstream at new tag
id: clone
env:
REPO: ${{ steps.detect.outputs.repo }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
run: |
SCRATCH=$(mktemp -d)
git clone --depth 1 --branch "$NEW_TAG" \
"https://github.com/${REPO}.git" \
"$SCRATCH/upstream"
echo "scratch_dir=$SCRATCH/upstream" >> "$GITHUB_OUTPUT"
- name: Sync declared assets
env:
PROJECT_ID: ${{ steps.detect.outputs.id }}
CLONE_DIR: ${{ steps.clone.outputs.scratch_dir }}
REPO: ${{ steps.detect.outputs.repo }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
run: |
node scripts/upstream-release/sync-assets.mjs \
--id "$PROJECT_ID" \
--clone "$CLONE_DIR" \
--repo "$REPO" \
--tag "$NEW_TAG"
# toolhive ships CRD manifests as a release asset tarball (see
# stacklok/toolhive#4982). We extract it to a temp dir and run our
# opinionated transforms: extract per-CRD JSON schemas + examples,
# generate MDX reference pages. Bundling the upstream-registry
# schema (resolves the remote MCP-server $refs for our JSON-Schema
# viewer) also runs here.
- name: Extract CRDs + generate reference MDX (toolhive)
if: steps.detect.outputs.id == 'toolhive'
env:
REPO: ${{ steps.detect.outputs.repo }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
run: |
TMP=$(mktemp -d)
gh release download "$NEW_TAG" --repo "$REPO" \
--pattern "thv-crds.tar.gz" --dir "$TMP"
mkdir -p "$TMP/crds"
tar -xzf "$TMP/thv-crds.tar.gz" -C "$TMP/crds"
TOOLHIVE_CRD_DIR="$TMP/crds" node scripts/extract-crd-schemas.mjs
node scripts/generate-crd-pages.mjs
node scripts/bundle-upstream-schema.mjs
rm -rf "$TMP"
# Commit AND PUSH the refreshed reference assets (synced release-
# asset files + regenerated toolhive CRD MDX if applicable) before
# the skill runs. Pushing here — rather than batching the push
# with the skill-content commit later — means refresh work is
# preserved on the PR even if the skill step fails or is
# cancelled. Also keeps the skill's content commit clean and
# lets the autogen-detect step below distinguish skill touches
# from our own legitimate refresh writes.
- name: Commit + push refreshed reference assets
id: refresh
env:
PROJECT_ID: ${{ steps.detect.outputs.id }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
HEAD_REF: ${{ steps.eff.outputs.head_ref }}
run: |
git add -A
if git diff --cached --quiet; then
echo "No reference changes for $PROJECT_ID $NEW_TAG."
echo "refreshed=false" >> "$GITHUB_OUTPUT"
else
git commit -m "Refresh reference assets for $PROJECT_ID $NEW_TAG"
# Someone may have pushed to HEAD_REF between our checkout
# and now (merges from main, etc). Rebase onto the latest
# tip before pushing so we don't fail with "fetch first".
git fetch origin "$HEAD_REF" --quiet
git rebase "origin/$HEAD_REF" || {
echo "::error::Rebase of the refresh commit onto origin/$HEAD_REF hit conflicts. Resolve manually on the PR branch."
exit 1
}
git push origin "HEAD:$HEAD_REF"
echo "refreshed=true" >> "$GITHUB_OUTPUT"
fi
# Anchor the "skill touched" set for the autofix step below.
# HEAD at this point is either the refresh commit (if it was
# non-empty) or the PR's pre-workflow tip. Either way, anything
# committed between this SHA and HEAD after the skill runs is
# attributable to the skill.
- name: Capture pre-skill SHA
id: pre_skill
run: echo "sha=$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT"
- name: Read docs_paths hint
id: hints
env:
PROJECT_ID: ${{ steps.detect.outputs.id }}
run: |
HINTS=$(node -e "
const yaml = require('yaml');
const fs = require('fs');
const p = yaml.parse(fs.readFileSync('.github/upstream-projects.yaml','utf8')).projects.find(x=>x.id===process.env.PROJECT_ID);
console.log(JSON.stringify(p?.docs_paths ?? []));
")
echo "docs_paths=$HINTS" >> "$GITHUB_OUTPUT"
# claude-code-action@v1 rejects track_progress: true on
# workflow_dispatch events with "track_progress is only
# supported for events: pull_request, issue_comment, ...".
# That means on manual retries and bootstrap dispatches, the
# PR gets no real-time "Claude is working on it" comment from
# the action -- a reviewer watching the PR has no visible
# signal that the skill is actually running. Post a static
# placeholder comment ourselves, scoped to workflow_dispatch
# runs so we don't duplicate the action's own tracking on
# normal Renovate-opened PRs.
- name: Post skill-started comment (workflow_dispatch only)
if: github.event_name == 'workflow_dispatch' && steps.eff.outputs.number != ''
env:
PR_NUMBER: ${{ steps.eff.outputs.number }}
RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
PROJECT_ID: ${{ steps.detect.outputs.id }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
run: |
# `|| true` so a transient gh failure doesn't abort the run
# before skill_gen executes. The comment is a visibility
# aid, not load-bearing.
gh pr comment "$PR_NUMBER" --body "Generating docs for \`$PROJECT_ID\` $NEW_TAG… ([run]($RUN_URL))" || true
# Invocation 1: generation. Runs /upstream-release-docs end-to-
# end (all 6 phases, including the skill's own internal
# docs-review in Phase 5). Uses Opus 4.7 — generation benefits
# from the stronger model on long multi-file edits and source
# verification.
- name: Run upstream-release-docs skill (generation)
id: skill_gen
# Wall-clock ceiling. Observed gen runs take 15–22 min depending
# on release scope; 45 min kills a stuck process before it
# burns the full 90-minute job budget. Paired with --max-turns
# below for a runaway-cost ceiling.
timeout-minutes: 45
uses: anthropics/claude-code-action@38ec876110f9fbf8b950c79f534430740c3ac009 # v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
additional_permissions: |
actions: read
# Allow the action to run when the triggering PR was opened
# by Renovate. Without this, claude-code-action refuses to
# run for bot-initiated workflows as a safety default.
allowed_bots: 'renovate'
# Real-time visibility into skill progress during long runs.
# track_progress posts a sticky tracking comment on the PR
# that updates as the skill works through each phase —
# BUT it's only supported for pull_request / issue_comment
# /* events. Setting it on workflow_dispatch fails the
# action with "track_progress is only supported for events
# ... Current event: workflow_dispatch", so gate it on the
# triggering event.
# display_report surfaces the Claude Code Report in the
# Actions Step Summary regardless of trigger.
track_progress: ${{ github.event_name == 'pull_request' }}
display_report: true
# Grant the `gh` CLI so the skill can fetch PR descriptions,
# compare ranges, and view linked issues as it was designed
# to. Without this, Claude Code's default Bash allowlist
# rejects gh and the skill has to work from commit messages
# only, which misses most of the "why" narrative that PR
# authors write at open time. GH_TOKEN for auth is already
# in the job env at the top of this workflow.
#
# --max-turns 1000: observed gen baselines are 20 turns
# (silent) to 152 (full content rebuild). 500 was the
# initial cap; bumped to 1000 for extra headroom on
# multi-feature releases and to stay well above the
# suspected-looping 397-turn v3-test run (still clips
# genuine runaways). Hitting the cap produces a loud
# failure -- raise deliberately if a release needs more.
claude_args: |
--model claude-opus-4-7
--max-turns 1000
--allowed-tools "Bash(gh:*) Bash(npm run build) Bash(npm run prettier) Bash(npm run prettier:fix) Bash(npm run eslint) Bash(npm run eslint:fix)"
prompt: |
You are running in GitHub Actions with no interactive user. Follow
these steps exactly and do NOT ask clarifying questions -- proceed
best-effort at every decision point.
PROJECT: ${{ steps.detect.outputs.id }}
REPO: ${{ steps.detect.outputs.repo }}
PREV_TAG: ${{ steps.detect.outputs.prev_tag }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
CLONE: ${{ steps.clone.outputs.scratch_dir }}
DOCS_HINTS: ${{ steps.hints.outputs.docs_paths }}
Run /upstream-release-docs ${{ steps.detect.outputs.repo }} ${{ steps.detect.outputs.new_tag }}
Execute all 6 phases. Prefer reading source code from the
local clone at ${{ steps.clone.outputs.scratch_dir }}
instead of `gh api contents?ref=<tag>` -- it's already at
the tag and doesn't consume API quota.
For Phase 2 step 4 (context on major new features), do the
following INSTEAD of the skill's default "ask the user"
behavior (there is no interactive user here):
1. Use `gh pr view <NUMBER> --repo ${{ steps.detect.outputs.repo }}
--json title,body,author` to fetch the PR description
for each major new feature. The PR body typically
contains the "why" framing the author wrote when
opening the PR -- motivation, intended consumers,
design decisions.
2. If the PR body references linked issues (look for
"Closes #N", "Fixes #N", "Refs #N"), fetch those
with `gh issue view <N> --repo ${{ steps.detect.outputs.repo }}`
when they are likely to contain product context.
3. Write the "why"/consumer narrative directly in the
relevant docs page using what you learned. This is a
best-effort pass -- reviewers will refine it during
normal review.
4. Only defer to GAPS.md when the rationale demonstrably
cannot be derived from available sources. Genuine
examples: the PR body points to an internal design
doc or product spec you cannot access; multiple
plausible consumer narratives exist and picking one
would mislead readers; a release timeline or
commitment needs product-team confirmation.
GAPS.md contract (only if you genuinely need to defer):
- ONLY include content gaps a human reviewer must fill
in. Do NOT include environment/sandbox limitations
(e.g. "couldn't run npm build") -- those are
infrastructure concerns; the PR's CI handles them.
Do NOT include "not a gap, documented for clarity"
commentary.
- Each entry MUST include a "Helper prompt for local
Claude" block a reviewer can paste verbatim into
their local Claude Code to resolve the gap. The
prompt must reference the specific file(s) to edit,
the PR number that provides context, and the narrow
piece of information the human needs to supply or
confirm.
- Each entry MUST @-mention the PR author (skip this
for bot authors: renovate[bot], github-actions[bot],
stacklokbot).
GAPS.md entry format:
```
### <Feature name> (PR #123 by @alice)
<One paragraph: what's missing, why you couldn't
resolve it from available sources.>
**File(s):** path/to/file.mdx
**Helper prompt for local Claude:**
> <Paste-ready prompt. Self-contained. References the
> specific file(s), the PR number, and the narrow
> piece of info needed. A human should be able to
> paste this into `claude` locally and get a usable
> response without additional context.>
```
Do NOT create GAPS.md if every feature's "why" was
resolvable from PR descriptions. An empty GAPS.md is
worse than no file.
Follow the skill's own guidance on auto-generated reference
files (Phase 4 step 5, Phase 4 step 6) -- do not hand-edit
docs/toolhive/reference/cli/, static/api-specs/, or
docs/toolhive/reference/crds/. Those are synced or
regenerated from release assets by earlier steps in this
workflow; if a release genuinely needs hand-written
reference updates, note that in GAPS.md.
If you conclude there are no doc-relevant changes for this
release (Phase 3 impact map is empty), stop and write
NO_CHANGES.md at repo root with a one-line explanation.
Still do not hand-edit any file.
BEFORE the final commit in Phase 6, write SUMMARY.md at
repo root with a concise bullet list of changes you made
on the docs side. This surfaces directly in the PR body
as a "Summary of changes" section so reviewers see what
actually shipped without clicking the diff.
Format each bullet as one of:
- `Added <what> at <path>` -- new pages/sections
- `Updated <what> in <path>` -- meaningful prose edits
- `Swept <what> across N files in <area>` -- repo-wide
renames, apiVersion bumps, etc.
- `Removed <what> from <path>` -- deletions
Keep the list to 3-8 bullets. Focus on what a reviewer
needs to know, not how you did it. If many files are
touched as one logical change (e.g. a v1alpha1 ->
v1beta1 apiVersion sweep), describe it as one bullet --
do not enumerate each file. Do NOT include bullets for
auto-generated reference files the refresh step
updated; only describe your hand-written edits.
Skip SUMMARY.md only when you wrote NO_CHANGES.md or
made zero hand-edits.
# Capture skill_gen's execution stats BEFORE skill_review runs
# and overwrites the shared execution-output JSON at the
# canonical claude-code-action location. Lets us report
# per-invocation turns/cost in the PR body and the workflow_
# dispatch summary comment. Missing-file defaults to 0 so a
# failed run still emits plausible outputs.
- name: Capture skill_gen stats
id: skill_gen_stats
if: always() && steps.skill_gen.conclusion == 'success'
run: |
LOG="/home/runner/work/_temp/claude-execution-output.json"
# claude-code-action writes a top-level JSON array of
# messages (init, assistant turns, tool calls, result).
# The final entry is a "result" object with the session
# summary (num_turns, total_cost_usd, etc.). Use recursive
# descent with a last-match tail so we pick up the summary
# regardless of where in the structure it lives, and so
# the query still works if the upstream format shifts
# between array and object. `|| echo 0` guards against
# jq errors on missing/malformed files.
if [ -f "$LOG" ]; then
TURNS=$(jq -r '[.. | .num_turns? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
COST=$(jq -r '[.. | .total_cost_usd? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
DENIALS=$(jq -r '[.. | .permission_denials_count? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
else
TURNS=0
COST=0
DENIALS=0
fi
# Format cost with 4 decimal places for readability.
COST_FMT=$(printf '%.4f' "$COST")
{
echo "turns=$TURNS"
echo "cost_usd=$COST_FMT"
echo "denials=$DENIALS"
} >> "$GITHUB_OUTPUT"
echo "skill_gen stats: turns=$TURNS cost=\$$COST_FMT denials=$DENIALS"
# Invocation 2: editorial re-review with FRESH CONTEXT. Running
# docs-review in a separate session — with no exposure to the
# generation session's internal reasoning — tends to catch style
# and structure issues the generation pass rationalized away.
# Also uses Opus 4.7 since docs-review benefits from the same
# model quality.
- name: Run docs-review on skill output (fresh context)
id: skill_review
if: always() && steps.skill_gen.conclusion == 'success'
# Editorial review is a short pass: 1-2 min wall clock, 4-5
# turns in every run so far. 10 / 30 are 5-6x buffers over
# baseline -- cheap safety net for the rare case where review
# spirals on a file it can't stop "improving".
timeout-minutes: 10
uses: anthropics/claude-code-action@38ec876110f9fbf8b950c79f534430740c3ac009 # v1
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
additional_permissions: |
actions: read
allowed_bots: 'renovate'
track_progress: ${{ github.event_name == 'pull_request' }}
display_report: true
# gh access parallels skill_gen so the review pass can
# re-verify claims against PR descriptions and linked
# issues if needed.
#
# --max-turns 200: initial cap of 30 was sized against
# silent-release baselines (4-6 turns) and was too tight
# for real content reviews. v0.24.0 (PR #788) hit it at
# turn 31 mid-review and failed the run; the editorial
# pass genuinely needs ~30-100 turns to walk a multi-
# file content PR. 200 gives 2x-6x headroom over that
# working range while still clipping a runaway.
claude_args: |
--model claude-opus-4-7
--max-turns 200
--allowed-tools "Bash(gh:*) Bash(npm run build) Bash(npm run prettier) Bash(npm run prettier:fix) Bash(npm run eslint) Bash(npm run eslint:fix)"
prompt: |
You are running in GitHub Actions with no interactive user. Follow
these steps exactly and do NOT ask clarifying questions -- proceed
best-effort at every decision point.
A previous Claude session just generated content for the
upstream release ${{ steps.detect.outputs.repo }} ${{ steps.detect.outputs.new_tag }}.
You are a fresh reviewer with no prior context from that
session. Your job is purely editorial.
Run /docs-review over every file the previous commit
changed (use `git show --name-only HEAD` or `git diff
--name-only HEAD~1 HEAD` to find them). Apply every
actionable fix per the skill's standard guidance.
If you spot a factual concern, re-verify against the
local clone at ${{ steps.clone.outputs.scratch_dir }}
first. You also have gh CLI access -- use `gh pr view
<N> --repo ${{ steps.detect.outputs.repo }}` to pull
context from the upstream PR if needed. Don't introduce
new claims; only refine what's already there.
Do NOT re-run /upstream-release-docs. Do NOT touch files
under docs/toolhive/reference/cli/, static/api-specs/,
or docs/toolhive/reference/crds/ — those are
regenerated from release assets and aren't yours to edit.
Do NOT touch GAPS.md, NO_CHANGES.md, or SUMMARY.md at
the repo root if they exist -- they're signal files
handed off to the next workflow step, not part of the
docs.
# claude-code-action works in a sibling scratch checkout (the
# .claude-pr/ dir we gitignore) and pushes commits to origin
# directly, without advancing the outer workflow checkout's
# HEAD. Without an explicit sync, every subsequent step that
# reads local git state (skill_commits counter, autofix's git
# diff) sees stale HEAD at the pre-skill SHA -- which is what
# caused PR #780's "skill_commits=0 despite a real skill
# commit" + unformatted files landing on CI unformatted.
#
# Fetch + fast-forward-merge origin so local HEAD reflects
# whatever the skill pushed. Fail loudly on fetch or merge
# errors -- silently continuing on stale HEAD reintroduces
# the exact skill_commits=0 + autofix-skips-files bugs this
# step is meant to prevent. Gated on skill_gen success; if
# gen didn't run, there's nothing for the skill to have
# pushed and this step is skipped.
# A no-op fast-forward (local already at origin, e.g. skill
# made no commits) exits 0 cleanly.
- name: Sync local branch with skill-pushed commits
if: always() && steps.skill_gen.conclusion == 'success'
env:
HEAD_REF: ${{ steps.eff.outputs.head_ref }}
run: |
git fetch origin "$HEAD_REF" --quiet
git merge --ff-only "origin/$HEAD_REF"
echo "Local HEAD after sync: $(git rev-parse HEAD)"
# Mirror of skill_gen_stats for skill_review. Reads the same
# canonical log path, which skill_review overwrote on exit.
- name: Capture skill_review stats
id: skill_review_stats
if: always() && steps.skill_review.conclusion == 'success'
run: |
LOG="/home/runner/work/_temp/claude-execution-output.json"
# claude-code-action writes a top-level JSON array of
# messages (init, assistant turns, tool calls, result).
# The final entry is a "result" object with the session
# summary (num_turns, total_cost_usd, etc.). Use recursive
# descent with a last-match tail so we pick up the summary
# regardless of where in the structure it lives, and so
# the query still works if the upstream format shifts
# between array and object. `|| echo 0` guards against
# jq errors on missing/malformed files.
if [ -f "$LOG" ]; then
TURNS=$(jq -r '[.. | .num_turns? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
COST=$(jq -r '[.. | .total_cost_usd? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
DENIALS=$(jq -r '[.. | .permission_denials_count? // empty] | last // 0' "$LOG" 2>/dev/null || echo 0)
else
TURNS=0
COST=0
DENIALS=0
fi
COST_FMT=$(printf '%.4f' "$COST")
{
echo "turns=$TURNS"
echo "cost_usd=$COST_FMT"
echo "denials=$DENIALS"
} >> "$GITHUB_OUTPUT"
echo "skill_review stats: turns=$TURNS cost=\$$COST_FMT denials=$DENIALS"
# Count the commits the skill itself added between pre_skill
# and now. Zero commits means skill_gen and skill_review both
# concluded there was nothing to change -- e.g. because main
# already has the content for this release (a re-run or test
# after the same content was merged via a different PR), or
# because the release genuinely had no doc-relevant impact
# but the skill didn't produce NO_CHANGES.md. Either way the
# resulting PR is silent and reviewers can't tell that from
# a successful run with content -- we emit a visible note in
# the PR body when this is the case.
- name: Count skill commits
id: skill_commits
if: always() && steps.skill_gen.conclusion == 'success'
env:
BASELINE_SHA: ${{ steps.pre_skill.outputs.sha }}
run: |
COUNT=$(git rev-list "$BASELINE_SHA..HEAD" --count)
echo "count=$COUNT" >> "$GITHUB_OUTPUT"
echo "Skill produced $COUNT commit(s) between pre_skill and now."
# Auto-apply the same formatters the project's pre-commit hook
# runs, scoped to the files the skill touched. The skill's
# sandbox doesn't include npm run prettier/eslint, so without
# this step any formatting drift lands on PR CI as a "Lint and
# format checks" failure requiring a human push. Scope via git
# diff vs the pre-skill SHA so we don't reformat auto-generated
# reference assets (which would fight the generators).
- name: Auto-fix prettier and eslint on skill-touched files
id: autofix
if: always() && steps.skill_gen.conclusion == 'success'
env:
BASELINE_SHA: ${{ steps.pre_skill.outputs.sha }}
run: |
# Files the skill added/modified, excluding the three
# auto-generated reference paths.
CHANGED=$(git diff --name-only "$BASELINE_SHA..HEAD" -- \
':!docs/toolhive/reference/cli/' \
':!docs/toolhive/reference/crds/' \
':!static/api-specs/' \
2>/dev/null | \
grep -E '\.(md|mdx|ts|tsx|js|jsx|mjs|cjs|css|json|jsonc|yaml|yml)$' || true)
if [ -z "$CHANGED" ]; then
echo "No skill-touched files in scope for autofix."
exit 0
fi
echo "Running prettier --write and eslint --fix on:"
echo "$CHANGED"
# xargs -0 with a NUL-delimited list so filenames with
# spaces survive.
printf '%s\n' "$CHANGED" | tr '\n' '\0' | \
xargs -0 npx prettier --write --log-level warn
# eslint --fix against mdx/ts/tsx/js only.
LINT_TARGETS=$(printf '%s\n' "$CHANGED" | \
grep -E '\.(mdx|ts|tsx|js|jsx|mjs|cjs)$' || true)
if [ -n "$LINT_TARGETS" ]; then
printf '%s\n' "$LINT_TARGETS" | tr '\n' '\0' | \
xargs -0 npx eslint --fix --no-error-on-unmatched-pattern || \
echo "::warning::eslint --fix reported non-zero; proceeding."
fi
if git diff --quiet; then
echo "No formatting changes needed."
else
git add -A
git commit -m "Apply prettier and eslint fixups to skill output"
fi
- name: Capture skill signal files
id: signals
env:
BASELINE_SHA: ${{ steps.pre_skill.outputs.sha }}
run: |
GAPS_BODY=""
NO_CHANGES_BODY=""
SUMMARY_BODY=""
if [ -f GAPS.md ]; then
GAPS_BODY=$(cat GAPS.md)
rm GAPS.md
fi
if [ -f NO_CHANGES.md ]; then
NO_CHANGES_BODY=$(cat NO_CHANGES.md)
rm NO_CHANGES.md
fi
if [ -f SUMMARY.md ]; then
SUMMARY_BODY=$(cat SUMMARY.md)
rm SUMMARY.md
fi
# Fallback summary from skill-authored commit titles when
# the skill didn't write SUMMARY.md. Extracted from the
# range between the pre-skill baseline and HEAD so it
# captures the skill's commits only (refresh commit is
# before the baseline). Each line is pre-formatted as a
# markdown bullet so downstream just has to echo.
COMMIT_FALLBACK=""
if [ -z "$SUMMARY_BODY" ] && [ -n "$BASELINE_SHA" ]; then
# Raw "<sha> <subject>" lines; awk reformats each as a
# markdown bullet with the short SHA in backticks.
# Backticks via awk's \x60 to avoid shellcheck SC2016
# on a single-quoted git-log format string.
COMMIT_FALLBACK=$(git log --reverse --format='%h %s' "$BASELINE_SHA..HEAD" 2>/dev/null | \
awk '{ sha=$1; sub("^" sha " *", ""); printf "- %s (\x60%s\x60)\n", $0, sha }' || true)
fi
# Build full markdown fragments here so the PR body edit
# step can treat them as plain strings.
{
echo "note_block<<NOTE_EOF"
if [ -n "$NO_CHANGES_BODY" ]; then
echo "> [!NOTE]"
echo "> The skill reported no doc-relevant changes for this"
echo "> release. This PR only bumps the version reference"
echo "> and any pin_files substitutions."
echo ">"
echo "> $NO_CHANGES_BODY"
fi
echo "NOTE_EOF"
echo "gaps_block<<GAPS_EOF"
if [ -n "$GAPS_BODY" ]; then
echo "## Gaps needing human context"
echo ""
echo "$GAPS_BODY"
fi
echo "GAPS_EOF"
# summary_block carries either the skill's hand-written
# SUMMARY.md body, or the commit-title fallback when the
# skill didn't write one. Empty when neither applies
# (e.g. silent run / NO_CHANGES case). The Augment step
# renders a "Summary of changes" section iff non-empty.
echo "summary_block<<SUMMARY_EOF"
if [ -n "$SUMMARY_BODY" ]; then
echo "$SUMMARY_BODY"
elif [ -n "$COMMIT_FALLBACK" ]; then
echo "_Auto-generated from commit titles -- skill did not write SUMMARY.md._"
echo ""
echo "$COMMIT_FALLBACK"
fi
echo "SUMMARY_EOF"
} >> "$GITHUB_OUTPUT"
- name: Apply pin_files substitutions
env:
PROJECT_ID: ${{ steps.detect.outputs.id }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
run: |
node scripts/upstream-release/apply-pin-files.mjs \
--id "$PROJECT_ID" \
--tag "$NEW_TAG"
- name: Detect touches to auto-generated paths
id: autogen
# Runs AFTER the skill and AFTER the refresh commit above, so
# the staged diff represents skill-introduced changes only.
# The Augment step consumes `touched` directly and composes
# the CAUTION alert itself -- no note block assembled here.
run: |
git add -A
TOUCHED=$(git diff --cached --name-only -- \
'docs/toolhive/reference/cli/' \
'static/api-specs/' \
'docs/toolhive/reference/crds/' | paste -sd, - || true)
echo "touched=$TOUCHED" >> "$GITHUB_OUTPUT"
- name: Commit and push
id: push
env:
PROJECT_ID: ${{ steps.detect.outputs.id }}
NEW_TAG: ${{ steps.detect.outputs.new_tag }}
HEAD_REF: ${{ steps.eff.outputs.head_ref }}
run: |
# Stage any skill content and add a content commit if non-empty.
git add -A
if ! git diff --cached --quiet; then
git commit -m "Add upstream-release-docs content for $PROJECT_ID $NEW_TAG"
else
echo "No skill content changes to commit."
fi
# Skill can take 20-45 min; during that window someone may
# push merges-from-main or other commits to the PR branch.
# Handle that safely:
# - If our local HEAD is already on origin (no new work
# to push), exit cleanly.
# - Otherwise rebase any local-only commits onto the
# latest origin tip, then push. Conflicts fail loudly.
git fetch origin "$HEAD_REF" --quiet
if git merge-base --is-ancestor HEAD "origin/$HEAD_REF" 2>/dev/null; then
echo "Origin is at or ahead of local; nothing to push."
else
git rebase "origin/$HEAD_REF" || {
echo "::error::Rebase of local commits onto origin/$HEAD_REF hit conflicts. Resolve manually on the PR branch."
exit 1
}
git push origin "HEAD:$HEAD_REF"
fi
# Reviewer assignment is deliberately at the end of the job (not
# at skill-start). Placement rationale: GitHub fires the