Add CHANGELOG.md and maintenance agent skill#193
Merged
data-douser merged 4 commits intomainfrom Mar 29, 2026
Merged
Conversation
- Create CHANGELOG.md covering all stable releases (v2.24.0 through v2.25.0) following Keep a Changelog v1.1.0 format with Highlights, Added, Changed, Fixed, Dependencies, and other standard sections - Add .github/instructions/changelog_md.instructions.md with formatting rules applied automatically when editing CHANGELOG.md (applyTo: 'CHANGELOG.md') - Add .github/skills/maintain-changelog/SKILL.md with a 5-phase workflow for drafting, classifying, and promoting changelog entries during releases - Cross-reference maintain-changelog in upgrade-codeql-cli-and-packs skill
Contributor
Dependency ReviewThe following issues were found:
|
data-douser
changed the title
CHANGELOG.md and maintenance agent skill
Contributor
There was a problem hiding this comment.
Pull request overview
Adds first-class changelog support (a root CHANGELOG.md) plus Copilot/agent documentation for maintaining it during release prep, aligning the repo’s release workflow with Keep a Changelog and stable-tag-only versioning.
Changes:
- Added a repository-root
CHANGELOG.mdwith stable release entries and link references. - Introduced Copilot instructions for
CHANGELOG.mdformatting and maintenance rules. - Added a new
maintain-changelogskill and linked it from the CodeQL upgrade skill.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CHANGELOG.md |
Adds an initial changelog with release sections, highlights, and reference links. |
.github/instructions/changelog_md.instructions.md |
Defines formatting/validation rules for changelog edits (Keep a Changelog, stable releases only, tables, links). |
.github/skills/maintain-changelog/SKILL.md |
Documents a workflow/heuristics for drafting and promoting changelog entries. |
.github/skills/upgrade-codeql-cli-and-packs/SKILL.md |
Cross-links the new changelog maintenance skill for release preparation. |
Comments suppressed due to low confidence (2)
CHANGELOG.md:33
- This “Added > MCP Server Prompts” subsection uses a bullet item, but the changelog formatting instructions require a two-column markdown table when listing new prompts/resources/tools. Please convert this to a table to match the established format used in earlier releases.
#### MCP Server Prompts
- Duplicated code detection prompts for guiding agents through finding and reporting code duplication. ([#109](https://github.com/advanced-security/codeql-development-mcp-server/pull/109))
CHANGELOG.md:43
- This “Changed > MCP Server Tools” entry is formatted as a bullet, but the changelog instructions require a two-column table (
| Tool | Change |) for changed tools. Please switch this subsection to a table (consistent with v2.24.3 and v2.24.2).
#### MCP Server Tools
- `codeql_database_analyze` — Fixed `additionalArgs` pass-through so extra CLI arguments are correctly forwarded. ([#188](https://github.com/advanced-security/codeql-development-mcp-server/pull/188))
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nathan Randall <70299490+data-douser@users.noreply.github.com>
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.
Summary of Changes
Changelog maintenance documentation and workflow:
.github/instructions/changelog_md.instructions.md, providing detailed, step-by-step instructions for maintainingCHANGELOG.mdin line with the Keep a Changelog specification, including formatting, section structure, and validation requirements..github/skills/maintain-changelog/SKILL.md, a new skill file outlining when and how to update the changelog, including workflow phases, classification heuristics, and entry formatting, with practical examples and references..github/skills/upgrade-codeql-cli-and-packs/SKILL.mdto reference the new maintain-changelog skill, ensuring contributors are aware of changelog update requirements during release preparation.