https://github.com/tsdtsdtsd/nextversion
Automatic semantic versioning utility
https://github.com/tsdtsdtsd/nextversion
cicd continuous-delivery continuous-deployment continuous-integration version version-control versioning
Last synced: about 2 months ago
JSON representation
Automatic semantic versioning utility
- Host: GitHub
- URL: https://github.com/tsdtsdtsd/nextversion
- Owner: tsdtsdtsd
- License: mit
- Created: 2024-02-10T03:20:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-21T21:55:34.000Z (4 months ago)
- Last Synced: 2025-01-21T22:33:35.884Z (4 months ago)
- Topics: cicd, continuous-delivery, continuous-deployment, continuous-integration, version, version-control, versioning
- Language: Go
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nextversion
> Automatic semantic versioning utility
![Latest Release Version][shields-version-img]
[![Godoc][godoc-image]][godoc-url]
[![Go Report Card][grc-image]][grc-url]
[![codecov][codecov-image]][codecov-url]
[](https://github.com/tsdtsdtsd/nextversion/actions/workflows/codeql-analysis.yml)
[shields-version-img]: https://img.shields.io/github/v/release/tsdtsdtsd/nextversion
[godoc-image]: https://pkg.go.dev/badge/github.com/tsdtsdtsd/nextversion.svg
[godoc-url]: https://pkg.go.dev/github.com/tsdtsdtsd/nextversion/pkg/nextversion/
[grc-image]: https://goreportcard.com/badge/github.com/tsdtsdtsd/nextversion
[grc-url]: https://goreportcard.com/report/github.com/tsdtsdtsd/nextversion
[codecov-image]: https://codecov.io/gh/tsdtsdtsd/nextversion/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/tsdtsdtsd/nextversion/tree/main
nextversion detects current application version based on git tags and suggests a bumped version based on [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/).
## Constraints
- nextversion needs annotated git tags to determine the current app version
- nextversion does not create tags for you, it only generates a suggestion
- nextversion sticks to [Semantic Versioning](https://semver.org/) and [Conventional Commits](https://www.conventionalcommits.org):
- your tags must follow the semver pattern without prerelease suffix and an optional `v` prefix (e.g. `v1.2.3` or `1.2.3`).
- you have to make sure that commit messages follow the [Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/).
The used parser is in [best effort mode](https://github.com/leodido/go-conventionalcommits#best-effort)
## Usage
```sh
# Let's check the CLI help screen
$ nextversion --help
NAME:
nextversion - versioning helper tool
USAGE:
nextversion [global options] [command]
VERSION:
v0.4.1
DESCRIPTION:
nextversion detects application version based on git tags and suggests a bumped version based on conventional commits.
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--repo PATH, -r PATH PATH to a git repository (default: "./")
--format FORMAT, -f FORMAT Output FORMAT (simple, json) (default: "simple")
--default-current VERSION, -d VERSION Fallback current VERSION if none could be detected (default: "v0.0.0")
--pre-stable, -p Breaking changes will not increase major version if current version matches v0.*.* (default: false)
--force-stable, -s Force updating to at least v1.0.0 (this has precedence over the --pre-stable flag) (default: false)
--help, -h show help
--version, -v print version of this tool (default: false)
# Run nextversion
~/my-repo$ nextversion
CURRENT=v0.1.2
CURRENT_STRICT=0.1.2
HAS_CURRENT=true
NEXT=v0.2.0
NEXT_STRICT=0.2.0
HAS_NEXT=true
PRERELEASE=v0.2.0-rc+main.cd81544
PRERELEASE_STRICT=0.2.0-rc+main.cd81544
# Please return JSON and make it readable
~/my-repo$ nextversion -f json | jq
{
"current": "v0.1.2",
"current-strict": "0.1.2",
"has-current": true,
"next": "v0.2.0",
"next-strict": "0.2.0",
"has-next": true,
"prerelease": "v0.2.0-rc+main.cd81544",
"prerelease-strict": "0.2.0-rc+main.cd81544"
}
```