Skip to content

Latest commit

 

History

History
172 lines (132 loc) · 5.04 KB

README.md

File metadata and controls

172 lines (132 loc) · 5.04 KB
Raw





🔖
Git Semantic Versioning

git-semv: This is a Git plugin for Semantic Versioning.





GitHub Workflow Status GitHub Workflow Status GitHub Release MIT License Go Documentation codecov

The usefulness of Semantic Versioning has been accepted by OSS in advance. And, with the appearance of Go modules, Semantic Versioning became indispensable for the development of the Go library. However, git tag used for versioning can not support pre-releases and sorts including build information for managing Semantic Versioning. Also, it is not easy to increment the version. This git-semv is a CLI tool for solving these problems and functions as git subcommand.

Japanese: https://tomohisaoda.com/posts/2018/do-semantic-versioning-for-app.html

Installation

Download the binary in Github Releases and place it in the directory where $PATH passed. Or, you can download using go get depending on the version of Go1.11 or higher.

$ go get -u github.com/linyows/git-semv/cmd/git-semv

Homebrew

$ brew tap linyows/git-semv
$ brew install git-semv

Usage

Show list:

# Only release versions
$ git semv
v0.0.1
v0.0.2
v1.0.0
v1.1.0
v1.1.1

# All versions including pre-release
$ git semv -a
v0.0.1
v0.0.2
v1.0.0-alpha.0+a2a784b.linyows
v1.0.0-beta.0+ba8a247.foobar
v1.0.0-rc.0
v1.0.0-rc.1
v1.0.0
v1.1.0
v1.1.1
v2.0.0-alpha.0

Show latest version:

$ git semv now
v1.1.1

Show next version(major|minor|patch):

# Next patch version
$ git semv patch
v1.1.2

# Next minor version
$ git semv minor
v1.2.0

# Next major version
$ git semv major
v2.0.0

Use options(pre|pre-name|build|build-name|bump):

# Next pre-release as major
$ git semv major --pre
v2.0.0-alpha.1

# Specify pre-release name as major
$ git semv major --pre-name beta
v2.0.0-beta.0

# Next minor version with build info
$ git semv minor --build
v1.2.0+9125b23.linyows

# Specify build name
$ git semv minor --build-name superproject
v1.2.0+superproject

# Create tag and Push origin
$ git semv patch --bump
Bumped version to v1.1.2
#==> git tag v1.1.2 && git push origin v1.1.2

VS.

motemen/gobump

gobump will increment the version according to semver in version in the source code. On the other hand, git-semv does not do anything to the source code. Even if you do, you just create a tag and push it remotely. When focusing on Go, Go can add version and other information to the build, so there is no need to manage version in code. Also, in other languages, you can easily replace them in code by combining with commands such as sed.

and git-semv supports versioning of pre-release and build information.

Development flow

The assumed development flow is...

  1. Development
  2. Remote push
  3. Pull-request create
  4. Continuous Integration
  5. Master branch merge
  6. Tag create and push(git-semv)
  7. Continuous Integration
  8. Release create(goreleaser)

Generally, development in Go will upload the product binary to github releases and release the product. There is a great tool called goreleaser which makes that work easier. By running this tool on the CI, we will automatically release the binary after pushing the created tag. And git-semv solves troublesome versioning and tag creation problem which is the next bottleneck.

Contribution

  1. Fork (https://github.com/linyows/git-semv/fork)
  2. Create a feature branch
  3. Commit your changes
  4. Rebase your local changes against the master branch
  5. Run test suite with the go test ./... command and confirm that it passes
  6. Run gofmt -s
  7. Create a new Pull Request

Author

linyows