managing-entries

Changelog entry management involves using the /changelog:add command to create entries categorized as breaking, feature, bugfix, or change. The tenzir-changelog framework automatically validates metadata, links PRs for traceability, and enables preview and export of release notes via CLI commands, eliminating manual error-prone processes.

Use uvx tenzir-changelog validate to check entry metadata and manifest compliance, then uvx tenzir-changelog release notes --json v1.0.0 to export validated release notes in JSON format. This workflow ensures consistency and prevents incomplete or malformed release documentation.

Yes, the tenzir-changelog framework supports PR-number linking within changelog entries. This creates traceability between specific code changes and their corresponding release notes, maintaining a clear audit trail throughout the release cycle.

Run uvx tenzir-changelog show to preview all current changelog entries. This lets you review entry formatting, completeness, and accuracy before validation and release note export, catching issues early in the workflow.

The tenzir-changelog framework defines four entry types: breaking for incompatible changes, feature for new functionality, bugfix for defect corrections, and change for general modifications. Categorizing entries accurately ensures release notes accurately reflect the nature and impact of each change.

Best practice is maintaining one entry per logical change, whether it spans multiple commits or files. This keeps release notes organized and meaningful, with PR links connecting each entry to its implementation for full traceability.