https://github.com/syncromatics/gogitver
Provides semantic versioning through git history
https://github.com/syncromatics/gogitver
git go semver
Last synced: about 1 month ago
JSON representation
Provides semantic versioning through git history
- Host: GitHub
- URL: https://github.com/syncromatics/gogitver
- Owner: syncromatics
- License: mit
- Created: 2018-08-01T01:10:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-12T23:20:39.000Z (almost 6 years ago)
- Last Synced: 2026-01-15T07:32:10.895Z (2 months ago)
- Topics: git, go, semver
- Language: Go
- Homepage:
- Size: 975 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gogitver
gogitver is a tool to determine the semantic version of a project based on keywords used in the commit history. This project draws a lot of inspiration from [GitVersion](https://github.com/GitTools/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
#### Snap
```snap install gogitver```
#### Binaries
To install download the latest release from the [releases](https://github.com/syncromatics/gogitver/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 in the git history it will bump the major version.
The default regex patterns gogitver will use are:
* Major: ```\+semver:\s?(breaking|major)```
* Minor: ```\+semver:\s?(feature|minor)```
* Patch: ```\+semver:\s?(fix|patch)```
However you can override these by providing a settings file ```.gogitver.yaml``` that looks like:
```yaml
major-version-bump-message: '(major|breaking)\(.*\)'
minor-version-bump-message: '(feat|feature|minor)\(.*\)'
patch-version-bump-message: '(patch|fix)\(.*\)'
```
You can also override the name and location of this file by providing the settings flag ```gotgitver --settings=./anotherfile.yaml```
## Development
### Requirements
This project requires at least [Go](https://golang.org/dl/) 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](https://github.com/src-d/go-git) - The git interface
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* [go-git](https://github.com/src-d/go-git) for allowing interactions with git to be easy and without dependencies
* [GitVersion](https://github.com/GitTools/GitVersion) for the inspiration
* [Visual Studio Code](https://code.visualstudio.com/) for just being an all around great editor