changelog-entry
Esta página aún no está disponible en tu idioma.
Instructions
-
Find the most recent git tag:
git describe --tags --abbrev=0If a tag exists, list commits since that tag:
git log --oneline --no-merges <last-tag>..HEADIf no tag exists (the repository has no releases yet), list all commits:
git log --oneline --no-merges -
Read each commit subject line and classify it into one of the Keep a Changelog sections:
- Added — new features, new files, new API endpoints, new configuration options
- Changed — changes to existing behavior, updated dependencies, modified defaults
- Fixed — bug fixes, corrected behavior, resolved errors
- Removed — deleted features, removed files, dropped API endpoints
- Deprecated — features that still work but are marked for future removal
- Security — vulnerability patches, authentication improvements, permission changes
Ignore merge commits, version bump commits, and changelog update commits. Ignore commits whose subject line is obviously tooling noise (dependency lock file updates with no semantic change, CI config tweaks that do not affect users).
-
Write the entry in Keep a Changelog format:
## [Unreleased]### Added- Description of added thing### Changed- Description of change### Fixed- Description of fixOmit sections that have no entries.
Write each bullet in present tense, starting with a verb: “Add”, “Fix”, “Remove”, “Update”. Do not start bullets with the commit type prefix (feat:, fix:, etc.) — strip those and rephrase.
-
Output only the new CHANGELOG block. Do not output any surrounding explanation.