Go Semver Release

Go program designed to automate versioning of Git repository by analyzing their formatted commit history and tagging them with the right SemVer number.

• Motivation
• Features
• Install
• Usage
• CI workflow examples
• How is this different from tool X ?

Motivation

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).

[!IMPORTANT] go-semver-release 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.

Features

• 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 (e.g. v1.0.0)
• Tag signature using GPG

Install

If Go is installed on your machine, you can install from source:

$ go install github.com/s0ders/go-semver-release/v5@latest
$ go-semver-release --help

A Docker image is available as well:

$ docker pull s0ders/go-semver-release:latest
$ docker run --rm s0ders/go-semver-release --help

Usage

Documentation about the CLI usage can be found here.

CI workflow examples

This tool is voluntarily agnostic of which CI tool is used with it. Examples of workflows with various CI tools can be found here.

How is this tool different from X ?

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 to avoid requiring the use of secret tokens on user-end (if you choose to run in local mode for instance).

As stated above, Go Semver Release is agnostic of which CI tool you use or which branch you use it on. You define the configuration using flags, environment variables or configurations file however you please on your CI for maximized modularity.