# README
\
\
[](https://github.com/avelino/awesome-go) [](https://img.shields.io/github/v/tag/s0ders/go-semver-release?label=Version\&color=bb33ff) [](https://img.shields.io/github/go-mod/go-version/s0ders/go-semver-release) [](https://pkg.go.dev/github.com/s0ders/go-semver-release/v5) [](https://img.shields.io/github/actions/workflow/status/s0ders/go-semver-release/main.yaml?label=CI) [](https://goreportcard.com/report/github.com/s0ders/go-semver-release/v5) [](https://app.codecov.io/github/s0ders/go-semver-release) [](https://github.com/s0ders/go-semver-release/blob/main/LICENSE.md) [](https://www.bestpractices.dev/projects/8877)
Go Semver Release is a CLI program designed to automate versioning of Git repository by analyzing their [formatted commit history](https://www.conventionalcommits.org) and tagging them with the right [SemVer](https://semver.org/spec/v2.0.0.html) number.
This documentation is also available at
## 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
* 📝 Tag signature using GPG
## 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](https://www.conventionalcommits.org/en/v1.0.0/) specification. Many IDEs support plugins that help formatting messages (e.g. [VSCode](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits), [IntelliJ](https://plugins.jetbrains.com/plugin/13389-conventional-commit)).
{% hint style="info" %}
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.
{% endhint %}
## How is this different from \ ?
Other tools exist to version software using semantic versions such as [semantic-release](https://github.com/semantic-release/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.
## Documentation
### Usage
* [Install](/usage/install.md)
* [Quickstart](/usage/quickstart.md)
* [Configuration](/usage/configuration.md)
* [Output](/usage/output.md)
### Recipes
* [Workflow examples](/recipes/workflow-examples.md)
### Miscellaneous
* [Benchmark](/miscellaneous/benchmark.md)
* [How it works](/miscellaneous/how-it-works.md)
***
Project's illustration designed by [@TristanDacross](https://github.com/TristanDacross)
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://go-semver-release.akira.sh/readme.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.