GeezerVison is showing github.com — Document change-notes process by mario-campos · Pull Request #4211 · github/codeql-action
Conversation
This PR documents the change-note validate command, how to write a proper change-note file, and links that back to the contribution section of CONTRIBUTING.md.
Risk assessment
For internal use only. Please select the risk level of this change:
- Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.
Which use cases does this change impact?
Workflow types:
Products:
Environments:
- Testing/None - This change does not impact any CodeQL workflows in production.
How did/will you validate this change?
- None - I am not validating these changes.
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Are there any special considerations for merging or releasing this change?
- No special considerations - This change can be merged at any time.
Merge / deployment checklist
- Confirm this change is backwards compatible with existing workflows.
- Consider adding a changelog entry for this change.
- Confirm the readme and docs have been updated if necessary.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Changes recommended
The documented release process promises change-note assembly that the current release automation does not perform.
2 open findings
What changed in this PR
Documents how contributors create and validate change-notes for the CodeQL Action changelog.
Changes:
- Links contribution guidance to the new change-notes section.
- Describes validation, filename requirements, categories, and body format with an example.
| File |
Description |
| CONTRIBUTING.md |
Adds change-note authoring and validation guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 Approval recommended
This documentation-only update has no blocking issues; remaining clarifications can be addressed later.
0 open findings
2 resolved since last review
Previously missed (2)
In code that hasn't changed since last review
 Clarify which changelog requirements are automatically validated
CONTRIBUTING.md:139
The validator checks filenames, category values, and list structure, but not the sentence limit or one-change-per-item guidance below (pr-checks/changelog/validate.ts). This wording makes those editorial requirements sound automatically enforced. Could you distinguish the automated checks from the writing guidance? This is a non-blocking clarification that can follow in a later PR.
Clarify validation stops after the first failing file
CONTRIBUTING.md:141
validate() in pr-checks/changenotes.ts stops calling isValidChangenoteFile once a file fails because the reducer uses r && .... Later files can therefore have unreported validation errors. Could you clarify that contributors may need to fix the reported file and rerun the command? The short-circuit behavior is pre-existing; this documentation clarification can follow in a later PR.
🧠 Review effort: Balanced
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟢 Approval recommended
The documentation and narrowly scoped processing change have no unresolved blocking issues.
0 open findings
🧠 Review effort: Balanced
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
mbg
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for preparing this and updating it based on my suggestion on the other PR!
The most significant comment I have is probably unrelated to this PR, which is that I didn't spot some of the validation requirements that were introduced in #4113 for the file names and the category metadata. See my detailed comments, but to me it looks like they are completely unnecessary and just add hoops that we have to jump through for no real reason? Am I missing something?
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Oct 14, 2026
Reviewers
mbg
mbg approved these changes
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Labels
size/XS
Should be very easy to review
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.
|