mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
281 lines
8.9 KiB
Markdown
281 lines
8.9 KiB
Markdown
GoReleaser builds Go binaries for several platforms, creates a GitHub release and then
|
|
pushes a Homebrew formula to a repository. All that wrapped in your favorite CI.
|
|
|
|
[](https://github.com/goreleaser/goreleaser/releases/latest)
|
|
[](LICENSE.md)
|
|
[](https://travis-ci.org/goreleaser/goreleaser)
|
|
[](https://goreportcard.com/report/github.com/goreleaser/goreleaser)
|
|
[](https://github.com/goreleaser)
|
|
|
|
This project adheres to the Contributor Covenant [code of conduct](../CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
We appreciate your contribution. Please refer to our [contributing guidelines](../CONTRIBUTING.md).
|
|
|
|
# Documentation
|
|
|
|
- [Introduction](#intorduction)
|
|
- [Quick start](#quick-start)
|
|
- [Environment setup](#environment-setup)
|
|
- [Release customization](#release-customization)
|
|
- [Integration with CI](#integration-with-ci)
|
|
|
|
## Introduction
|
|
|
|
GoReleaser is a release automation tool for Golang projects, the goal is to simplify the build, release and publish steps while providing variant customization options for all steps.
|
|
|
|
GoReleaser is built for CI tools; you only need a [single command line](#integration-with-ci) in your build script. Therefore, no package is required.
|
|
You can define your [customization](#release-customization) in a `goreleaser.yml` file.
|
|
We are also working on integrating package managers, we currently support Homebrew.
|
|
|
|
The idea started with a [simple shell script](https://github.com/goreleaser/old-go-releaser), but it quickly became more complex and I also wanted to publish binaries via Homebrew.
|
|
|
|
_So, the all-new GoReleaser was born._
|
|
|
|
## Quick start
|
|
|
|
In this example we will build, archive and release a Golang project.
|
|
Create a GitHub repository and add a single main package:
|
|
```go
|
|
// main.go
|
|
package main
|
|
|
|
func main() {
|
|
println("Ba dum, tss!")
|
|
}
|
|
```
|
|
By default GoReleaser will build the **main.go** file located in your current directory, but you can change the build package path in the GoReleaser configuration file.
|
|
|
|
```yml
|
|
# goreleaser.yml
|
|
# Build customization
|
|
build:
|
|
binary_name: drum-roll
|
|
goos:
|
|
- windows
|
|
- darwin
|
|
- linux
|
|
goarch:
|
|
- amd64
|
|
```
|
|
|
|
This configuration specifies the build operating systems to Windows, Linux and MacOS using 64bit architecture, the name of the binaries is "drum-roll".
|
|
|
|
GoReleaser will then archive the result binaries of each Os/Arch into a separate file. The default format is `{{.BinaryName}}_{{.Os}}_{{.Arch}}`.
|
|
You can change the archives name and format. You can also replace the OS and the Architecture with your own.
|
|
Another useful feature is to add files to archives, this is very useful for integrating assets like resource files.
|
|
|
|
```yml
|
|
# goreleaser.yml
|
|
# Build customization
|
|
build:
|
|
main: main.go
|
|
binary_name: drum-roll
|
|
goos:
|
|
- windows
|
|
- darwin
|
|
- linux
|
|
goarch:
|
|
- amd64
|
|
# Archive customization
|
|
archive:
|
|
format: tar.gz
|
|
replacements:
|
|
amd64: 64-bit
|
|
darwin: macOS
|
|
linux: Tux
|
|
files:
|
|
- drum-roll.licence.txt
|
|
```
|
|
|
|
This configuration will generate tar archives, contains an additional file "drum-roll.licence.txt", the archives will be located in:
|
|
"./dist/drum-roll_windows_64-bit.tar.gz"
|
|
"./dist/drum-roll_macOS_64-bit.tar.gz"
|
|
"./dist/drum-roll_Tux_64-bit.tar.gz"
|
|
|
|
Next export a `GITHUB_TOKEN` environment variable with the `repo` scope selected. This will be used to deploy releases to your GitHub repository. Create yours [here](https://github.com/settings/tokens/new).
|
|
```sh
|
|
export GITHUB_TOKEN=`YOUR_TOKEN`
|
|
```
|
|
|
|
GoReleaser uses the latest [Git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) of your repository.
|
|
Create a tag:
|
|
```sh
|
|
git tag -a v0.1 -m "First release"
|
|
```
|
|
|
|
Now you can run GoReleaser at the root of your repository:
|
|
```sh
|
|
curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
|
|
```
|
|
|
|
That's it! Check your GitHub release page.
|
|
The release on will look like this:
|
|
|
|
[
|
|
](https://github.com/goreleaser/goreleaser/releases)
|
|
|
|
## Environment setup
|
|
|
|
### GitHub Token
|
|
GoReleaser requires a GitHub API token with the `repo` scope checked to deploy the artefacts to GitHub. You can create one [here](https://github.com/settings/tokens/new).
|
|
This token should be added to the environment variables as `GITHUB_TOKEN`. Here is how to do it with Travis-ci: [Defining Variables in Repository Settings](https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings).
|
|
|
|
### A note about `main.version`
|
|
|
|
GoReleaser always sets a `main.version` ldflag. You can use it in your
|
|
`main.go` file:
|
|
|
|
```go
|
|
package main
|
|
|
|
var version = "master"
|
|
|
|
func main() {
|
|
println(version)
|
|
}
|
|
```
|
|
|
|
`version` will always be the name of the current Git tag.
|
|
|
|
## Release customization
|
|
|
|
GoReleaser provides multiple customizations. We will cover them with the help of _goreleaser.yml_:
|
|
|
|
```yml
|
|
# goreleaser.yml
|
|
# Build customization
|
|
build:
|
|
# Path to main.go file.
|
|
# Default is `main.go`
|
|
main: ./cmd/main.go
|
|
|
|
# Name of the binary. Default is the name of the project directory.
|
|
binary_name: program
|
|
|
|
# Custom ldflags.
|
|
# Default is `-s -w`
|
|
ldflags: -s -w
|
|
|
|
# GOOS list to build in.
|
|
# For more info refer to https://golang.org/doc/install/source#environment
|
|
# Defaults are darwin and linux
|
|
goos:
|
|
- freebsd
|
|
- windows
|
|
|
|
# GOARCH to build in.
|
|
# For more info refer to https://golang.org/doc/install/source#environment
|
|
# Defaults are 386 and amd64
|
|
goarch:
|
|
- amd64
|
|
|
|
|
|
# Archive customization
|
|
archive:
|
|
# You can change the name of the archive.
|
|
# This is parsed with Golang template engine and the following variables
|
|
# are available:
|
|
# - BinaryName
|
|
# - Version
|
|
# - Os
|
|
# - Arch
|
|
# The default is `{{.BinaryName}}_{{.Os}}_{{.Arch}}`
|
|
name_template: "{{.BinaryName}}_{{.Version}}_{{.Os}}_{{.Arch}}"
|
|
|
|
# Archive format. Valid options are `tar.gz` and `zip`.
|
|
# Default is `tar.gz`
|
|
format: zip
|
|
|
|
# Replacements for GOOS and GOARCH on the archive name.
|
|
# The keys should be valid GOOS or GOARCH values followed by your custom
|
|
# replacements.
|
|
# By default, `replacements` replace GOOS and GOARCH values with valid outputs
|
|
# of `uname -s` and `uname -m` respectively.
|
|
replacements:
|
|
amd64: 64-bit
|
|
386: 32-bit
|
|
darwin: macOS
|
|
linux: Tux
|
|
|
|
# Additional files you want to add to the archive.
|
|
# Defaults are any files matching `LICENCE*`, `LICENSE*`,
|
|
# `README*` and `CHANGELOG*` (case-insensitive)
|
|
files:
|
|
- LICENSE.txt
|
|
- README.md
|
|
- CHANGELOG.md
|
|
|
|
|
|
# Release customization
|
|
release:
|
|
# Repo in which the release will be created.
|
|
# Default is extracted from the origin remote URL.
|
|
repo: user/repo
|
|
|
|
|
|
# The brew section specifies how the formula should be created
|
|
# Check this link for details: https://github.com/Homebrew/brew/blob/master/docs/How-to-Create-and-Maintain-a-Tap.md
|
|
brew:
|
|
# Reporitory to push the tap to.
|
|
repo: user/homebrew-tap
|
|
|
|
# Folder inside the repository to put the formula.
|
|
# Default is the root folder.
|
|
folder: Formula
|
|
|
|
# Caveats for the user of your binary.
|
|
# Default is empty.
|
|
caveats: "How to use this binary"
|
|
|
|
# Dependencies of your formula.
|
|
# For more info, check https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md
|
|
dependencies:
|
|
- pkg-config
|
|
- jpeg
|
|
- boost
|
|
- readline
|
|
- gtk+
|
|
- x11
|
|
|
|
```
|
|
|
|
By defining the _brew_ property, GoReleaser will take care of publishing the Homebrew tap.
|
|
Assuming that the current tag is `v1.2.3`, the above config will generate a _program.rb_ formula in the _Formula_ folder of _homebrew-tap_ repository:
|
|
|
|
```rb
|
|
class Program < Formula
|
|
desc "How to use this binary"
|
|
homepage "https://github.com/user/homebrew-tap"
|
|
url "https://github.com/user/repo/releases/download/{version}/program_v1.2.3_macOs_64bit.zip"
|
|
version "v1.2.3"
|
|
sha256 "9ee30fc358fae8d248a2d7538957089885da321dca3f09e3296fe2058e7fff74"
|
|
|
|
def install
|
|
bin.install "program"
|
|
end
|
|
end
|
|
```
|
|
|
|
## Integration with CI
|
|
|
|
You may want to wire this to auto-deploy your new tags on [Travis](https://travis-ci.org), for example:
|
|
|
|
```yaml
|
|
# .travis.yml
|
|
after_success:
|
|
test -n "$TRAVIS_TAG" && curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
|
|
```
|
|
|
|
Here is how to do it with [CircleCI](https://circleci.com):
|
|
```yml
|
|
# circle.yml
|
|
deployment:
|
|
master:
|
|
branch: master
|
|
commands:
|
|
- curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
|
|
```
|
|
|
|
---
|
|
|
|
Would you like to fix something in the documentation? Feel free to open an [issue](https://github.com/goreleaser/goreleaser/issues).
|