A small command-line utility to manage CHANGELOG.md written in keepachangelog.com format.
Works nicely on any sized Git repository, even awesome on Monorepo.
Please download ZIP archive from releases page.
Run release to show full list of commands and flags.
release target will show you all CHANGELOG.md files recursively.
release target
release target --dir path/to/entrypoint
release t -d path/to/entrypointrelease unreleased will grab [Unreleased] sections of all CHANGELOG.md files recursively.
release unreleased
release unreleased --dir path/to/entrypoint
release u -d path/to/entrypointrelease show will output all previous version histories.
release show -v 0.1.0
release show -v 0.1.0 --dir path/to/entrypoint
release s -v 0.1.0 -d path/to/entrypointrelease latest
release latest --newline=false
release lBy default, release to -v X.Y.Z will ask you for confirmation.
release to -v 0.2.0
# Targets
## .github/workflows/CHANGELOG.md
## CHANGELOG.md
✔ Enter `yes` to update all CHANGELOGs to version [0.8.0]: yesIf you want to integrate with CI pipeline, use --force or -f.
release to -v 0.2.0 --force
# Targets
## .github/workflows/CHANGELOG.md --> ✅
## CHANGELOG.md --> ✅
Done👍release next will suggest you the next available version.
release next
Latest released version: 0.8.0
Suggestions for next release:
- Major / Release --> 1.0.0
- Minor / Feature --> 0.9.0
- Patch / Hotfix --> 0.8.1For CI integrations, add --type flag.
The words major, minor and patch comes from Semantic Versioning 2.0.0 idiom.
release next --type major
1.0.0
release next --type minor
0.9.0
release next --type patch
0.8.1Note this command will not add newline when --type flag is specified.
Use --newline flag if you prefer to see the newline.
release next --type major --newlineGitFlow idiom is also supported.
release next --type release
1.0.0
release next --type feature
0.9.0
release next --type hotfix
0.8.1The tool also supports Github-style semver:
release show -v v0.1.0
release to -v v0.2.0make runmake testmake build