Skip to content

Trim the review cards' boilerplate - #21920

Merged
CamSoper merged 3 commits into
masterfrom
camsoper/magical-gauss-rvf2iz
Sep 28, 2026
Merged

CamSoper merged 3 commits into
masterfrom
camsoper/magical-gauss-rvf2iz

Conversation

@CamSoper

Copy link
Copy Markdown
Contributor

Proposed changes

Follow-up to #21908. It cuts fixed text on both review cards that repeated something else on the card, or said nothing.

Author card

  • "How to answer" only while something blocks. A "nothing blocks merge" card still carried the collapsed fold, which opens "Every 🚨 and ❓ item above needs one of these". Now the fold drops when the count hits zero and comes back if a finding reopens.
  • Shorter callouts:
    • Blocking: "You = the PR author. Answer every item below before this PR can merge." followed by the reply format. "A reply without the #update-review tag doesn't count" stays in the always-visible callout.
    • Nothing blocking: "Nothing here needs an answer from you. A human reviewer still approves the merge."
  • Shorter browser-editing hint, style-suggestion caption, and closing line.

Reviewer's guide

  • Footer is one line: "something look wrong? Comment @claude <your point> #update-review and the review re-checks with your input." The rest ("the ⚠️ items above are the minutes that matter", where the author's items live) repeated the TIP callout and the Waiting-on-the-author block.
  • TIP callout: "Check the ⚠️ items, then approve. Your approval covers only those; links, shortcodes, metadata, and verified claims were checked by machine (receipts on the evidence page). Code samples are read, not compiled."
  • Shorter Waiting-on-the-author lead-in and "Not your area?" hand-off line.
  • An empty editorial-stances list renders nothing. It used to render a heading, a caption, and "None", right under a ⚠️ line saying the stances "still need a human eye" (Show the 👀 on PRs whose branch predates the reaction helper #21918's guide). The validator already accepts an absent block when there are no records, and the evidence page keeps the extractor's record.

Old cards pick this up on their next refresh. Both refresh lanes now re-write both cards' footers from the templates. Before this, a card kept whatever footer it was first published with, so cards from before #21908, like #21760's, kept the fully expanded "### How to answer" through every refresh. The rest of the fixed text follows on the next refresh the same way.

The v2 monolith (pre-v3 PRs) keeps its long style caption and its explicit-empty stances block, because its output is pinned byte-identical by test_v2_golden_unchanged.

Testing

🤖 Generated with Claude Code

https://claude.ai/code/session_01GKHS8qr1o8N7QkAdtHyWPz


Generated by Claude Code

Author card:
- Drop the collapsed "How to answer" fold when nothing blocks merge. It
  opened "Every 🚨 and ❓ item above needs one of these" on cards that
  had none. It comes back if a finding reopens.
- Shorter IMPORTANT/NOTE callouts, browser hint, v3 style caption, and
  closing line.

Reviewer's guide:
- The footer is one line: how to push back with #update-review. The rest
  ("the minutes that matter", where the author's items live) repeated
  the TIP callout and the Waiting-on-the-author block.
- Shorter TIP callout, Waiting-on-the-author lead-in, and hand-off line.
- An empty editorial-stances list renders nothing instead of a heading,
  caption, and "None" under a line saying stances "still need a human
  eye". The v2 monolith keeps its explicit-empty form and long captions
  (its golden output is pinned).

Both refresh lanes now re-stamp both cards' footers from the templates
(build-evidence.restamp_footer). Before, a card kept whatever footer it
was first published with, so pre-fold cards like #21760 kept an
expanded "### How to answer" through every refresh.

Compat sweep over the 31 open PRs with v3 cards: 0 new validator
violations on as-is, no-op, and real refreshes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GKHS8qr1o8N7QkAdtHyWPz
@github-actions

github-actions Bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

Sentinel — merge gate status (preview)

Warning

⚠️ Preview mode — this check is NOT blocking your merge

The Sentinel is in preview (report-only) mode: its check-run concludes neutral whatever the gates below say, so nothing here gates this PR. The rows are informational and safe to ignore for now. It would have concluded failure.

This will be enforced in the near future. Once it is, every row below has to be green before this PR can merge. The rows are the sign-offs a merge needs — some yours, some a reviewer's or a deploy's. Tell us in #docs if one looks wrong.

1 of 5 gates would block this merge once the Sentinel is enforced.

Gate What it needs
✅ G1 review-ran Nothing to do: review current at 3a6b06f7d.
✅ G2 findings-answered Nothing to do: every finding answered.
🔴 G3 right-approver Needs approval from a member of any review team (pulumi/docs-blog-review, pulumi/docs-guild, pulumi/docs-marketing-review, pulumi/docs-tools) or a repository administrator — no qualifying human approval at this head (bot approvals never count).
➖ G4 infra-evidence Doesn't apply to this PR: no changed path affects the deploy.
➖ G5 oversized-ack Doesn't apply to this PR: not oversized.

Break glass: a member of a routing team (.github/review-routing.yml teams:) can apply review:waived, which is logged.

Evaluated at head 3a6b06f7d.

@CamSoper
CamSoper marked this pull request as ready for review September 26, 2026 00:15
@github-actions github-actions Bot added review:triaging Claude Triage is currently classifying the PR domain:other PR touches no domain-specific path; reviewed under shared criteria only labels Sep 26, 2026
@pulumi-bot
pulumi-bot requested a review from a team September 26, 2026 00:16
@github-actions github-actions Bot removed the review:triaging Claude Triage is currently classifying the PR label Sep 26, 2026
A refresh already rewrote the author card's callout and both footers;
the guide's TIP callout was the one piece of fixed text an old card kept
through every refresh. apply-update now swaps it for the composer's
current one (build-evidence.restamp_brief_orient).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GKHS8qr1o8N7QkAdtHyWPz
@github-actions

github-actions Bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Contributor

🤖 Review errored. Flip to draft and back to ready, or mention @claude #update-review, to retry.

@github-actions github-actions Bot added the review:in-progress Claude review is currently running label Sep 26, 2026
@pulumi-bot

pulumi-bot commented Sep 26, 2026 •

Copy link
Copy Markdown
Collaborator

@github-actions github-actions Bot added review:error Workflow failed before publishing a review; see Actions logs and removed review:in-progress Claude review is currently running labels Sep 26, 2026
The v3 self-check refuses drafts that carry v2 section names like
"⚠️ Low-confidence", to catch composer scaffolding that wasn't
rewritten. It scanned the whole draft, including text quoted from the
PR. This PR edits output-format.md, whose changed line mentions
"⚠️ Low-confidence"; the extractor listed it as an editorial stance,
the stance bullet quoted it, the self-check failed, and the review
errored (run 36204219422). Any PR that edits the review docs could hit
the same thing.

Quoted text always renders through quote() inside *"…"*, so the check
now strips those spans first. Reproduced with that stance: CAUTION
banner before the fix, none after.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GKHS8qr1o8N7QkAdtHyWPz

Copy link
Copy Markdown
Contributor Author

@claude #new-review

(The first review errored on a composer self-check that tripped on text quoted from this PR's own diff. Fixed in 3a6b06f.)


Generated by Claude Code

Copy link
Copy Markdown
Contributor Author

@claude #new-review

(Retry: the previous request was cancelled by the triage run from the same push, which then skipped.)


Generated by Claude Code

@github-actions github-actions Bot added review:in-progress Claude review is currently running and removed review:error Workflow failed before publishing a review; see Actions logs labels Sep 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Reviewer's guide v1 — not for the author

Tip

Check the ⚠️ items, then approve. Your approval covers only those; links, shortcodes, metadata, and verified claims were checked by machine (receipts on the evidence page). Code samples are read, not compiled.

PR author: nothing here is yours. Your to-do list is the "Author action guide" comment.

Approval needed from: @pulumi/docs-tools — any member's approval satisfies the merge gate.

Note

What this PR changes:

  • Review card footers: author and reviewer footer text shortened.
  • compose-review.py: card boilerplate trimmed and the stale-vocabulary check now skips quoted PR text.
  • build-evidence.py: evidence page takes over content moved off the cards.
  • apply-update.py and post-style-suggestions.py: adjusted to the trimmed card layout.
  • Tests and v3 fixtures updated to match.

The risk is a composer or evidence-builder change that drops or misrenders a finding on the published cards. The claim pipeline and the infra-domain read of the changed scripts ran; tests weren't run in this review.

Review confidence:

Dimension Level Notes
mechanics MEDIUM script changes read, not executed; rely on make test-review-pipeline in CI
facts HIGH

⚠️ Check these before approving

No findings to check — but the editorial stances below still need a human eye.

Editorial stances introduced by this PR

Superlatives and comparisons the diff adds. Framing isn't fact-checkable, so confirm each is a stance the docs should take.

  • L340 .claude/commands/docs-review/references/output-format.md — "- Editorial stances (no verdict). compose-review.py renders a second H4 inside ⚠️ Low-confidence, before #### Style suggestions: `#### Editorial…" — comparison (found by regex)
  • L340 .claude/commands/docs-review/references/output-format.md — "- Editorial stances (no verdict). compose-review.py renders a second H4 inside ⚠️ Low-confidence, before #### Style suggestions: `#### Editorial…" — positioning (found by regex)

✅ What you can rubber-stamp

  • Facts: 1 factual claim checked — 1 verified clean.
  • Mechanics: no internal links added.
  • Style: 0 advisory suggestions left with the author; never blocking.

Pre-existing issues in touched files: 0 — details on the evidence page.

Full evidence: verification trail, investigation log, review history.

Review v1 · updated 2026-09-26T00:44:23Z · head commit 3a6b06f


For the reviewer: something look wrong? Comment @claude <your point> #update-review and the review re-checks with your input.

@github-actions

Copy link
Copy Markdown
Contributor

Author action guide v1 — nothing blocks merge

Note

Nothing here needs an answer from you. A human reviewer still approves the merge.

This PR trims boilerplate from the v3 review cards (footers, composer and evidence-page output, style-suggestion posting) and updates tests and fixtures; the review checked the changed scripts, reference docs, and the one factual claim.

Full evidence: verification trail, investigation log, review history.

Review v1 · updated 2026-09-26T00:44:23Z · head commit 3a6b06f


Please don't edit or delete this comment; it's the review's record.

@github-actions github-actions Bot added review:no-blockers Claude review completed cleanly; outstanding is empty and removed review:in-progress Claude review is currently running labels Sep 26, 2026
@CamSoper
CamSoper merged commit 0ca86bc into master Sep 28, 2026
19 checks passed
@CamSoper
CamSoper deleted the camsoper/magical-gauss-rvf2iz branch September 28, 2026 18:32

This branch was successfully deployed

1 active deployment
testing — 3a6b06f7 Deployed Sep 28, 2026 by CamSoper via Do cleanup #14448
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain:other PR touches no domain-specific path; reviewed under shared criteria only review:no-blockers Claude review completed cleanly; outstanding is empty

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants