Skip to content

chore: keep the review payload out of the doc-check summary comment - #31994

Merged
nickvigilante merged 1 commit into
mainfrom
ci/doc-check-summary-body
Nov 12, 2026
Merged

nickvigilante merged 1 commit into
mainfrom
ci/doc-check-summary-body

Conversation

@nickvigilante

Copy link
Copy Markdown
Collaborator

The doc-check agent posted the raw JSON of its review request as the summary comment on #31385 (comment), so GitHub showed {"commit_id": ..., "event": "COMMENT", "body": "## Documentation Check\n..."} with escaped newlines. The inline review on that run posted correctly. Of the latest summary comments on 42 PRs reviewed since 2026-10-25, this is the only malformed one.

This changes .claude/skills/doc-check/output.md so the agent:

  • writes the review request to review.json and leaves the review body empty, which matches what every other run does;
  • writes the summary to its own summary.md, never reuses review.json for it, and posts or edits it with exact gh api ... -F body=@summary.md commands;
  • checks, when it reads the comment back, that the body starts with ## Documentation Check and ends with the marker, and fixes it with PATCH if not.

Follow-up: workflow guard (not in this PR yet)

A workflow job that fails the run when the sticky summary comment does not start with ## Documentation Check is ready, but the bot that opened this PR can't push changes under .github/workflows/. The patch adds a check-summary-comment job (needs: doc-check, pull-requests: read) at the end of doc-check.yaml, after delete-workspace, so it stays clear of the hunks #31720 changes. It passed actionlint (with shellcheck) and zizmor --offline with no findings, and a dry run against live comments failed on #31385 and passed on #31896 and #31934.

Related open PRs: #31649 (draft) also edits output.md, and #31720 edits doc-check.yaml. Whichever lands second may need a small rebase.

Supersedes #31966, reopened under a human author for attribution.

@nickvigilante nickvigilante added the community Pull Requests and issues created by the community. label Nov 10, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante nickvigilante self-assigned this Nov 10, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive
@nickvigilante
nickvigilante temporarily deployed to main November 10, 2026 15:55 — with GitHub Actions Inactive

@ianjevans ianjevans left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

…ment

The doc-check agent posted the raw JSON of its review request as the summary comment on #31385. Tell the agent to write the summary to its own Markdown file, give it the exact post and edit commands, and check that the comment starts with the summary heading when it reads it back.
@nickvigilante
nickvigilante force-pushed the ci/doc-check-summary-body branch from 11d1cfd to 5f71925 Compare November 12, 2026 13:53
@nickvigilante
nickvigilante temporarily deployed to main November 12, 2026 13:53 — with GitHub Actions Inactive
@nickvigilante
nickvigilante enabled auto-merge (squash) November 12, 2026 13:53
@nickvigilante nickvigilante changed the title ci(.github): keep the review payload out of the doc-check summary comment chore: keep the review payload out of the doc-check summary comment Nov 12, 2026
@nickvigilante
nickvigilante temporarily deployed to main November 12, 2026 13:55 — with GitHub Actions Inactive
@nickvigilante
nickvigilante merged commit 553c8ca into main Nov 12, 2026
29 of 31 checks passed
@nickvigilante
nickvigilante deleted the ci/doc-check-summary-body branch November 12, 2026 13:57
@nickvigilante
nickvigilante temporarily deployed to main November 12, 2026 13:57 — with GitHub Actions Inactive
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 12, 2026

This branch was previously deployed

1 inactive deployment
main — 5f71925d Deployed Nov 12, 2026 by nickvigilante via cla #254951
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

community Pull Requests and issues created by the community.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants