https://github.com/tomodian/release
A command-line utility to manage Keep-a-changelog formatted changelogs. Written in Go, works nicely on Monorepo.
https://github.com/tomodian/release
changelog cli devops go keep-a-changelog keepachangelog linux macos monorepo release-automation release-management
Last synced: 2 months ago
JSON representation
A command-line utility to manage Keep-a-changelog formatted changelogs. Written in Go, works nicely on Monorepo.
- Host: GitHub
- URL: https://github.com/tomodian/release
- Owner: tomodian
- License: mpl-2.0
- Created: 2020-07-16T07:30:18.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-12-08T06:55:32.000Z (about 1 year ago)
- Last Synced: 2024-12-08T07:25:07.454Z (about 1 year ago)
- Topics: changelog, cli, devops, go, keep-a-changelog, keepachangelog, linux, macos, monorepo, release-automation, release-management
- Language: Go
- Homepage: https://github.com/tomodian/release
- Size: 130 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - release - CLI for Keep-a-changelog formatted changelogs. (Utilities / Utility/Miscellaneous)
- awesome-go - release - CLI for Keep-a-changelog formatted changelogs. (Utilities / Utility/Miscellaneous)
- awesome-go-with-stars - release - a-changelog formatted changelogs. | 2024-12-08 | (Utilities / Utility/Miscellaneous)
- fucking-awesome-go - release - CLI for Keep-a-changelog formatted changelogs. (Utilities / Utility/Miscellaneous)
README
# Release
[](https://pkg.go.dev/github.com/tomodian/release)
[](https://github.com/tomodian/release/actions/workflows/test.linux.yml)
[](https://github.com/tomodian/release/actions/workflows/release.yml)
[](https://codecov.io/gh/tomodian/release)
[](https://github.com/tomodian/release/releases)
A small command-line utility to manage CHANGELOG.md written in [keepachangelog.com](https://keepachangelog.com) format.
Works nicely on any sized Git repository, even awesome on [Monorepo](https://en.wikipedia.org/wiki/Monorepo).
## Installation
Please download ZIP archive from [releases](https://github.com/tomodian/release/releases) page.
## How it works
Run `release` to show full list of commands and flags.
### List all CHANGELOG.md
`release target` will show you all CHANGELOG.md files recursively.
```bash
release target
release target --dir path/to/entrypoint
release t -d path/to/entrypoint
```
### See unreleased changes
`release unreleased` will grab `[Unreleased]` sections of all CHANGELOG.md files recursively.
```bash
release unreleased
release unreleased --dir path/to/entrypoint
release u -d path/to/entrypoint
```
### See previous versions
`release show` will output all previous version histories.
```bash
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/entrypoint
```
### Show the latest released version in current directory
```bash
release latest
release latest --newline=false
release l
```
### Bump all [Unreleased] sections to given version
By default, `release to -v X.Y.Z` will ask you for confirmation.
```bash
release to -v 0.2.0
# Targets
## .github/workflows/CHANGELOG.md
## CHANGELOG.md
✔ Enter `yes` to update all CHANGELOGs to version [0.8.0]: yes
```
If you want to integrate with CI pipeline, use `--force` or `-f`.
```bash
release to -v 0.2.0 --force
# Targets
## .github/workflows/CHANGELOG.md --> ✅
## CHANGELOG.md --> ✅
Done👍
```
### See next release version
`release next` will suggest you the next available version.
```bash
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.1
```
For CI integrations, add `--type` flag.
The words `major`, `minor` and `patch` comes from [Semantic Versioning 2.0.0](https://semver.org) idiom.
```bash
release next --type major
1.0.0
release next --type minor
0.9.0
release next --type patch
0.8.1
```
Note this command will not add newline when `--type` flag is specified.
Use `--newline` flag if you prefer to see the newline.
```bash
release next --type major --newline
```
[GitFlow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) idiom is also supported.
```bash
release next --type release
1.0.0
release next --type feature
0.9.0
release next --type hotfix
0.8.1
```
### Github-style semver `vx.y.z`
The tool also supports [Github-style semver](https://semver.org/#is-v123-a-semantic-version):
```bash
release show -v v0.1.0
release to -v v0.2.0
```
## Development
### Run
```bash
make run
```
### Test
```bash
make test
```
### Build
```bash
make build
```
## License
[Mozilla Public License v2.0](LICENSE)