Release this

Home › Reference › Commands › Release › This

release this - Finalize changelog and prepare module for release

Updates the changelog with all commits since the last release and prepares the module for release.

This command: 1. Analyzes commits since the last release tag 2. Generates changelog entries from conventional commits 3. Merges any manual entries from [Unreleased] section 4. Calculates the next version (respecting constraints from .r2r/eac/repository.yml) 5. Adds a new version section to the changelog 6. Clears the [Unreleased] section 7. Writes the updated changelog

Manual entries in [Unreleased] are preserved and merged with auto-generated entries. This allows team members to add changelog entries that aren't tied to specific commits.

After running this command, commit the changelog and create a PR. Once merged, the release-auto workflow will detect the new version and create the git tag, which triggers the module's release workflow.

Flags

Flag	Description
--dry-run	Preview changes without writing to changelog
--json	Output result in JSON format
--date	Override release date (YYYY-MM-DD format)

Notes

Expected Output:

• Updated changelog with new version section added
• [Unreleased] section cleared
• Changelog file ready to be committed and submitted in a pull request

Examples

release this r2r-cli                      # Update single module changelog
release this r2r-cli ext-eac              # Update multiple modules
release this r2r-cli ext-eac --dry-run    # Preview without writing
release this r2r-cli --json               # Output result as JSON

See Also

• release changelog
• release check-ci
• validate release
• release Commands

---

Tutorials | How-to Guides | Explanation | Reference

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