Type | Implemendet | Git tag | Changelog | Release | Write access git | Api token |
---|---|---|---|---|---|---|
github |
✅ | ✅ | ✅ | ✅ | ✅ | |
gitlab |
✅ | ✅ | ✅ | ✅ | ✅ | |
git |
✅ | ✅ | ✅ | |||
bitbucket |
Comming soon | ✅ | ✅ |
- Github Actions
- Gitlab CI
- Travis CI
- Custom CI, set enviroment
CI=true
You can download the newest version under releases
or
you can use a Docker image
docker pull nightapes/go-semantic-release:<VERSION>
or docker pull docker.pkg.github.com/nightapes/go-semantic-release/go-semantic-release:<VERSION>
go-semantic-release
config file
Create a file with the name .release.yml
or anything else, but you need to set to every command -c <your config file>
commitFormat: angular
branch:
master: release
release: 'github'
github:
repo: "go-semantic-release"
user: "nightapes"
assets:
- name: ./build/go-semantic-release
compress: false
- name: ./build/go-semantic-release.exe
compress: false
hooks:
preRelease:
- name: echo $RELEASE_VERSION
postRelease:
- name: echo $RELEASE_VERSION
Set the commit format, at the moment we support ony angular, more coming soon.
commitFormat: angular
You can define which kind of release should be created for different branches.
Supported release kinds:
release
->v1.0.0
rc
->v1.0.0-rc.0
beta
->v1.0.0-beta.0
alpha
->v1.0.0-alpha.0
Add a branch config to your config
branch:
<branch-name>: <kind>
At the moment we support releases to gitlab and github.
You need to set the env GITHUB_TOKEN
with an access token.
release: 'github'
github:
user: "<user/group"
repo: "<repositroyname>"
## Optional, if your not using github.com
customUrl: <https://your.github>
You need to set the env GITLAB_ACCESS_TOKEN
with an personal access token.
release: 'gitlab'
gitlab:
repo: "<repositroyname>" ## Example group/project
## Optional, if your not using gitlab.com
customUrl: <https://your.gitlab>
Only via https at the moment. You need write access to your git repository
release: 'git'
git:
email: "<email>" # Used for creating tag
user: "<user>" : # Used for creating tag and pushing
auth: "<token>" # Used for pushing, can be env "$GIT_TOKEN", will be replaced with env
You can upload assets to a release
Support for gitlab and github. If you want, you can let the file be compressed before uploading
assets:
- name: ./build/go-semantic-release
compress: false
Hooks will run when calling release
. Hooks run only if a release will be triggered.
Following variables can be used for templates:
Commits
stringVersion
stringNow
time.TimeBacktick
stringHasDocker
boolHasDockerLatest
boolDockerRepository
string
changelog:
printAll: false ## Print all valid commits to changelog
title: "v{{.Version}} ({{.Now.Format "2006-01-02"}})" ## Used for releases (go template)
templatePath: "./examples/changelog.tmpl" ## Path to a template file (go template)
You can print a help text for a docker image
changelog:
docker:
latest: false ## If you uploaded a latest image
repository: ## Your docker repository, which is used for docker run
go-semantic-release
has two modes for calcualting the version: automatic or manual.
Version will be calculated on the next
or release
command
If you don't want that go-semantic-release
is calculating the version from the commits, you can set the version by hand with
following command:
./go-semantic-release set 1.1.1
Print the next version, can be used to add version to your program
./go-semantic-release next // show next version (calculated by new commits since last version)
./go-semantic-release last // show last released version
Example with go-lang
go build -ldflags "--X main.version=`./go-semantic-release next`"
./go-semantic-release release
go build ./cmd/go-semantic-release/
go test ./...
curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.16.0
golangci-lint run ./...