VerifiedStructure, tool compatibility and security checks passed. Pinned to a commit.
changelog-keeper·by
Maintains CHANGELOG.md in the Keep a Changelog format from merged commits and pull requests, groups entries by Added, Changed, Fixed and more, and prepares the section for a new release. Use when the user prepares a release or asks to update the changelog.
From allowed-tools, bundled files and the security scan. Your agent's own permission settings still apply.
SKILL.md45 linesShow sourceHide source
Similar packages
RW
Official Verified
by ·v1.0.0
Writes or improves a project README that explains what the project does, how to install, use and configure it, and how to contribute, based on the actual code. Use when the user asks for a README, better docs for a repository or onboarding instructions.
3description: Maintains CHANGELOG.md in the Keep a Changelog format from merged commits and pull requests, groups entries by Added, Changed, Fixed and more, and prepares the section for a new release. Use when the user prepares a release or asks to update the changelog.
4license: MIT
5version: 1.0.0
6---
7
8# Changelog keeper
9
10Keep `CHANGELOG.md` useful for the people who use the project — not a copy of the git log.
11Format: [Keep a Changelog 1.1](https://keepachangelog.com/en/1.1.0/), versions follow
12[Semantic Versioning](https://semver.org).
13
14## Collect changes
15
161. Find the last release: the newest version heading in `CHANGELOG.md` and its git tag
17 (`git describe --tags --abbrev=0`).
182. List what happened since: `git log --oneline <last-tag>..HEAD` and, if available, the merged
19 pull requests.
203. Drop entries users do not care about (refactors, CI, typo fixes in comments) unless they
21 change behaviour.
22
23## Write entries
24
25Add them under `## [Unreleased]`, grouped in this order:
26
27- `### Added` — new features
28- `### Changed` — changes in existing behaviour
29- `### Deprecated` — soon-to-be removed features
30- `### Removed` — removed features
31- `### Fixed` — bug fixes
32- `### Security` — vulnerabilities fixed
33
34Each entry is one line, written for users, with a link to the pull request or issue when there is
35one: `- Webhook deliveries are retried with backoff (#214).`
36
37## Release
38
39When the user is ready to release version `X.Y.Z`:
40
411. Suggest the version from the changes: breaking → major, added → minor, fixes only → patch.
422. Rename `[Unreleased]` to `[X.Y.Z] - YYYY-MM-DD` (today's date) and add an empty
43`[Unreleased]` section above it.
443. Update the comparison links at the bottom of the file.
454. Show the diff; do not tag or publish the release yourself.
Find the last release: the newest version heading in CHANGELOG.md and its git tag
(git describe --tags --abbrev=0).
List what happened since: git log --oneline <last-tag>..HEAD and, if available, the merged
pull requests.
Drop entries users do not care about (refactors, CI, typo fixes in comments) unless they
change behaviour.
Write entries
Add them under ## [Unreleased], grouped in this order:
### Added — new features
### Changed — changes in existing behaviour
### Deprecated — soon-to-be removed features
### Removed — removed features
### Fixed — bug fixes
### Security — vulnerabilities fixed
Each entry is one line, written for users, with a link to the pull request or issue when there is
one: - Webhook deliveries are retried with backoff (#214).
Release
When the user is ready to release version X.Y.Z:
Suggest the version from the changes: breaking → major, added → minor, fixes only → patch.
Rename [Unreleased] to [X.Y.Z] - YYYY-MM-DD (today's date) and add an empty
[Unreleased] section above it.
Update the comparison links at the bottom of the file.
Show the diff; do not tag or publish the release yourself.
