README
¶
gogitver
gogitver is a tool to determine the semantic version of a project based on key words used in the commit history. This project draws a lot of inspiration from GitVersion but with the benefit of go's single binary executable. With the work done by go-git the binary produced can run on Linux, Windows, and Mac.
Getting Started
Installing
To install download the latest release from the releases page for your machine architecture and place the binary in your path. You can then run the executable while in the path of your project and it should output the current version. You can then use this version to tag container images, helm charts, etc.
Usage
To get this most out of this tool you should be adding keywords to your git commits.
Example:
git commit -m "(+semver: breaking) this change adds a breaking change to the public api"
When gogitver sees this commit is the git history it will bump the major version.
Currently the keywords are hardcoded but I'm planning on adding the ability to add a yaml config file to allow these to defined in the individual projects using the tool.
- Major:
(+semver: major) | (+semver: breaking) - Minor:
(+semver: minor) | (+semver: feature) - Patch:
(+semver: patch) | (+semver: fix)
Development
Requirements
This project requires at least Go 1.11 because it makes use of go modules for dependencies.
Building
To build the project simply run make build which will generate the binaries and put them in the artifacts folder.
Built With
- go-git - The git interface
License
This project is licensed under the MIT License - see the LICENSE.md file for details
Acknowledgments
- go-git for allowing interactions with git to be easy and without dependencies
- GitVersion for the inspiration
- Visual Studio Code for just being an all around great editor
Directories