gorelease

README

Go Release!

A simple program to handle GitHub releases for Go repositories.

Get

go get github.com/nwillc/gorelease
go install

Setup

Your repository should contain the following:

.version
LICENSE.md
version/version.go

Your Semantic Version

The .version file should contain the semantic version you want to use, for example 0.1.0.

Your Code License

The test in this file will be used as a comment for the version.go files generated.

Your Version Go File

This can be empty to start, gorelease will create a valid Go file basically containing:

package version

var Version = "v0.1.0"

This can be referenced in your Go.

Use

Assuming you've set up as above.

1. Commit your code in preparation for release.
2. Update the .version file with a new version number.
3. Run gorelease, or use a //go:generate go run gorelease in your code and go generate

This will:

1. generate a new version/version.go
2. Create a tag with the version
3. push the tag
4. push the repository

If the push fails do to some credential issues it will inform you how to do it manually.