Skip to content

Release changelog

release changelog - Generate or update changelog from commits

Analyzes commits since the last release tag and generates changelog entries.

The command reads conventional commit messages (feat, fix, refactor, etc.) and categorizes them into changelog sections (Added, Fixed, Changed, etc.).

By default, shows a preview of the changelog entries without writing. Use --write to update the changelog file.

Flags

Flag Description
--write Write changes to changelog file (default: preview only)
--from Start from specific tag/ref (default: latest release tag)
--to End at specific tag/ref (default: HEAD)
--version Override calculated version number
--date Override release date (YYYY-MM-DD format)
--breaking Force major version bump

Notes

Expected Output:

  • Preview of changelog entries (default)
  • Updated release//CHANGELOG.md file if --write flag is specified

Examples

release changelog r2r-cli              # Preview changelog entries
release changelog r2r-cli --write      # Update release/r2r-cli/CHANGELOG.md
release changelog r2r-cli --from v1.0  # From specific tag

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.