| name | managing-entries |
| description | Create and manage changelog entries. Use when adding changelog entries, finishing features or bugfixes, documenting changes, writing release notes, working in changelog/ directories, wrapping up commits and PRs, or cutting a release. |
Changelog and Release Notes Management
This skill helps you create and manage changelog entries and release notes using the tenzir-changelog framework.
When to Use
- After completing a feature, bugfix, or breaking change
- When the user asks to create a changelog entry
- When working on PR descriptions that reference changelog items
- When validating existing changelog entries
- When viewing or exporting release notes
Entry Types
| Type | Use When |
|---|---|
breaking |
User action required (API changes, removed features, renamed options) |
feature |
New capability that didn't exist before |
bugfix |
Something was broken and is now fixed (crashes, wrong output, regressions) |
change |
Modifications to existing functionality (improvements, refactoring, tweaks) |
Use Cases
Add an Entry
Use the /changelog:add slash command.
Show Entries
Show unreleased entries in table format:
uvx tenzir-changelog show
Prefer structured output via the --json flag:
# Show detailed metadata for a specific entry.
uvx tenzir-changelog show --json 1
# Export as JSON.
uvx tenzir-changelog show --json
# Show a specific release.
uvx tenzir-changelog show --json v1.0.0
Validate
uvx tenzir-changelog validate
Checks entry structure, required fields, and manifest consistency. Reports missing metadata, duplicate IDs, and config drift.
Preview Release Notes
Preview release notes without modifying files:
uvx tenzir-changelog release notes --json v1.0.0
Best Practices
- One entry per logical change - Don't combine unrelated changes
- Link PRs - Always include PR numbers for traceability
- Breaking changes - Clearly explain migration steps in the body
- Preview first - Always preview releases before committing
- Validate in CI - Automate validation to enforce metadata completeness