Repository navigation
chore: keep the review payload out of the doc-check summary comment - #31994
Merged
Merged
Conversation
ThomasK33
approved these changes
Nov 12, 2026
…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
force-pushed
the
ci/doc-check-summary-body
branch
from
November 12, 2026 13:53
11d1cfd to
5f71925
Compare
nickvigilante
enabled auto-merge (squash)
November 12, 2026 13:53
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdso the agent:review.jsonand leaves the reviewbodyempty, which matches what every other run does;summary.md, never reusesreview.jsonfor it, and posts or edits it with exactgh api ... -F body=@summary.mdcommands;## Documentation Checkand ends with the marker, and fixes it withPATCHif 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 Checkis ready, but the bot that opened this PR can't push changes under.github/workflows/. The patch adds acheck-summary-commentjob (needs: doc-check,pull-requests: read) at the end ofdoc-check.yaml, afterdelete-workspace, so it stays clear of the hunks #31720 changes. It passedactionlint(with shellcheck) andzizmor --offlinewith 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 editsdoc-check.yaml. Whichever lands second may need a small rebase.Supersedes #31966, reopened under a human author for attribution.