Comment out stale-check in generated lock.yml#24435
Merged
Conversation
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/0c454581-6ea8-44b4-a206-4d0e533021aa Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
pelikhan
April 4, 2026 03:52
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes generated lock workflow YAML so the on.stale-check gh-aw extension key is emitted as a comment (documentation-only) rather than as an active GitHub Actions trigger key.
Changes:
- Updated
commentOutProcessedFieldsInOnSectionto comment outstale-check:in the compiled"on":section. - Added test assertions ensuring
stale-checkis not emitted as an active YAML key in lock output when present in frontmatter.
Show a summary per file
| File | Description |
|---|---|
| pkg/workflow/frontmatter_extraction_yaml.go | Comments out stale-check: in the compiled on: YAML and annotates it with a reason. |
| pkg/workflow/stale_check_test.go | Adds assertions validating stale-check is commented out (and not an active key) in generated lock output. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
Comment on lines
+103
to
105
| // commentOutProcessedFieldsInOnSection comments out draft, fork, forks, names, manual-approval, stop-after, skip-if-match, skip-if-no-match, skip-roles, reaction, lock-for-agent, steps, permissions, and stale-check fields in the on section | ||
| // These fields are processed separately and should be commented for documentation | ||
| // Exception: names fields in sections with __gh_aw_native_label_filter__ marker in frontmatter are NOT commented out |
There was a problem hiding this comment.
The function doc comment enumerates which on: fields are commented out, but the implementation also comments additional extension keys (e.g., skip-bots, roles, bots, github-token, github-app, skip-if-check-failing, etc.). Since this list is now inaccurate, consider either updating it to reflect all commented keys or rewriting it more generally (e.g., “comments out gh-aw extension keys processed elsewhere”) to avoid future drift.
Suggested change
| // commentOutProcessedFieldsInOnSection comments out draft, fork, forks, names, manual-approval, stop-after, skip-if-match, skip-if-no-match, skip-roles, reaction, lock-for-agent, steps, permissions, and stale-check fields in the on section | |
| // These fields are processed separately and should be commented for documentation | |
| // Exception: names fields in sections with __gh_aw_native_label_filter__ marker in frontmatter are NOT commented out | |
| // commentOutProcessedFieldsInOnSection comments out gh-aw extension keys in the on | |
| // section that are processed separately and should be preserved as comments for | |
| // documentation. Exception: names fields in sections with | |
| // __gh_aw_native_label_filter__ marker in frontmatter are NOT commented out. |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
stale-checkis a gh-aw extension key in theon:frontmatter section. It was being emitted as an active YAML key in compiled lock files, which is incorrect — GitHub Actions doesn't recognize it and it belongs only as documentation.Changes
frontmatter_extraction_yaml.go— Addedstale-check:tocommentOutProcessedFieldsInOnSection, alongside other processed fields likemanual-approval,skip-roles, etc.stale_check_test.go— Added assertions verifyingstale-checkis emitted as a comment (not an active key) in the lock file.on.stale-checknow produces: