fix: limit doc-check comments by restricting to one sticky comment and updating logic#21933
Merged
DevelopmentCats merged 3 commits intomainfrom Feb 6, 2026
Merged
fix: limit doc-check comments by restricting to one sticky comment and updating logic#21933DevelopmentCats merged 3 commits intomainfrom
DevelopmentCats merged 3 commits intomainfrom
Conversation
DevelopmentCats
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the doc-check workflow by implementing sticky comment logic to prevent multiple doc-check comments on the same PR. It also simplifies context messages for better clarity.
Changes:
- Simplified context messages for different PR trigger types (new PR, updates, label requests, etc.)
- Introduced sticky comment mechanism using
<!-- doc-check-sticky -->HTML marker - Added detailed instructions for updating existing doc-check comments (checking off items, strikethrough for reverted items, adding new items)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
I'll revisit the comment length constraints once I've had a chance to see how this change performs in practice. |
david-fraley
approved these changes
Feb 6, 2026
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.
This pull request updates the documentation review workflow in
.github/workflows/doc-check.yamlto improve clarity and introduce sticky comment logic for doc-check reviews. The changes focus on refining the review context messages and providing detailed instructions for updating existing doc-check comments, ensuring more consistent and actionable documentation feedback.Workflow message and prompt improvements:
Sticky comment logic and instructions:
<!-- doc-check-sticky -->and update it instead of creating a new one, supporting more efficient and organized review threads.<!-- doc-check-sticky -->marker is placed at the end of the comment for easier identification and updates in future runs.