2019-07-14 16:51:10 +00:00
|
|
|
# gitsem
|
|
|
|
|
|
|
|
|
|
A command line utility for managing semantically versioned (semver) git tags.
|
|
|
|
|
|
|
|
|
|
Run this in a git repository to bump the version and write the new data back to the VERSION file.
|
|
|
|
|
It will also create a version commit and (optional) tag, and fail if the repo is not clean.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
$ go get github.com/Clever/gitsem
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
```shell
|
|
|
|
|
$ gitsem patch
|
|
|
|
|
$ gitsem -m "Upgrade to %s for reasons" patch
|
|
|
|
|
$ gitsem minor
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
gitsem [options] version
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`version` can be one of: `newversion | patch | minor | major`
|
|
|
|
|
|
|
|
|
|
The version argument should be a valid semver string, or a field of a semver string (one of "patch", "minor", or "major").
|
|
|
|
|
In the second case, the existing version will be incremented by 1 in the specified field.
|
|
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
- `m=%s` specifies a commit message to use when bumping the version. If %s appears, it will be replaced with the new version number.
|
|
|
|
|
- `tag=true` whether or not to create a tag at the version commit
|
2021-10-06 17:33:14 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Vendoring
|
|
|
|
|
|
|
|
|
|
Please view the [dev-handbook for instructions](https://github.com/Clever/dev-handbook/blob/master/golang/godep.md).
|
