Changelog Keep a Changelog Update
Use this workflow to update CHANGELOG.md from current repository changes in a deterministic and evidence-based way.
Reference format: https://keepachangelog.com/en/1.0.0/
Workflow
- Resolve target file and scope.
- Collect current changes from git evidence.
- Map evidence to Keep a Changelog categories.
- Update
CHANGELOG.mdwithout fabricating details. - Verify structure, links, and consistency.
0) Resolve scope (required)
- If
CHANGELOG.mdexists at repository root, update it. - If the user specifies another changelog path, honor that path.
- If no changelog file exists, ask one clarification question before creating a new file.
- Never update unrelated markdown files as fallback.
1) Collect evidence (required)
Use repository facts only:
git status --shortfor changed files.git diff --name-onlyfor touched paths.git diff/git log --onelinefor behavior-level context.- Existing
CHANGELOG.mdheadings and version link style.
Do not claim behavior changes that cannot be traced to code or commit evidence.
2) Classify changes (required)
Map each verified change to these sections under [Unreleased]:
AddedChangedDeprecatedRemovedFixedSecurity
Rules:
- Prefer concise, user-facing entries.
- Group related file-level changes into one logical bullet.
- Omit empty categories unless the file already keeps empty headings intentionally.
3) Update rules (required)
- Preserve existing heading order and version history.
- Ensure
[Unreleased]exists near the top. - Insert new bullets under the correct category in
[Unreleased]. - Keep markdown clean and consistent with existing style.
- If uncertainty remains, add
TBD (owner needed)instead of guessing.
Version/date example (Keep a Changelog style):
## [Unreleased]
### Added
- Add validation for missing target paths before write operations.
## [1.2.0] - 2026-02-24
### Added
- Add `changelog-keepachangelog-update` skill with deterministic update workflow.
### Changed
- Improve README governance sections for ownership and escalation visibility.
4) Verification gates
Before final output, verify:
- Keep a Changelog structure remains valid for the file's style.
- No duplicate bullets for the same change.
- All new entries are evidence-backed.
- Existing historical versions are unchanged unless explicitly requested.
Output contract
Return:
- Updated changelog path.
- Short summary of added/changed/fixed/security entries.
- Any unresolved
TBD (owner needed)items.