Go Semver Release is a CLI program designed to automate versioning of Git repository by analyzing their formatted commit history and tagging them with the right SemVer number.
This documentation is also available at https://go-semver-release.akira.sh
- 🏷️ Automatic semantic versioning of your Git repository via annotated Git tags
- 🌐 Local or remote mode of execution (local removes the need for secret token)
- 🌴 Support for multiple release branch, prerelease and build metadata
- 🗂️ Support monorepo (i.e. multiple projects inside a single repository, all versioned separately)
- ⚙️ Custom tag prefix
- 📝 Tag signature using GPG
This project was built to create a lightweight and simple tool to automate the semantic versioning on your Git repository in a language and CI agnostic way by strictly following the Semantic Versioning and Conventional Commit convention.
Following the UNIX philosophy of "make each program do one thing well", it only handles publishing SemVer tags to your Git repository, no package publishing or any other features.
All you need to have is an initialized Git repository, a release branch (e.g. main) and a formatted commit history on that branch following the Conventional Commit specification. Many IDEs support plugins that help formatting messages (e.g. VSCode, IntelliJ).
Note
This program can only read annotated Git tags. If at some point you need to manually add a SemVer tag to your repository, make sure it is annotated, otherwise the program will not be able to detect it.
Other tools exist to version software using semantic versions such as semantic-release. Go Semver Release focuses on versioning only, no package publishing, release log generation or other features.
If you want a simple tool that handle the generation of the next semantic version tag for your project, you are at the right place. This allows the program to work with minimal dependencies and work faster.
Project's illustration designed by @TristanDacross