3.7 KiB
Install
There are two GoReleaser distributions: OSS and Pro.
You can install the pre-compiled binary (in several different ways), use Docker or compile from source (when on OSS).
Here are the steps for each of them:
Install the pre-compiled binary
homebrew tap
oss
brew install goreleaser/tap/goreleaser
pro
brew install goreleaser/tap/goreleaser-pro
homebrew
OSS-only, may not be the latest version.
brew install goreleaser
snapcraft
OSS only.
sudo snap install --classic goreleaser
scoop
oss
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser
pro
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser-pro
deb, rpm and apk packages
Download the .deb, .rpm or .apk from the OSS or Pro releases pages and install them with the appropriate tools.
shell script
OSS only.
curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh
go install
OSS only.
go install github.com/goreleaser/goreleaser
manually
Download the pre-compiled binaries from the OSS or Pro releases pages and copy to the desired location.
Running with Docker
You can also use it within a Docker container. To do that, you'll need to execute something more-or-less like the examples bellow.
oss
Registries:
Example usage:
docker run --rm --privileged \
-v $PWD:/go/src/github.com/user/repo \
-v /var/run/docker.sock:/var/run/docker.sock \
-w /go/src/github.com/user/repo \
-e GITHUB_TOKEN \
-e DOCKER_USERNAME \
-e DOCKER_PASSWORD \
-e DOCKER_REGISTRY \
goreleaser/goreleaser release
pro
Registries:
Example usage:
docker run --rm --privileged \
-v $PWD:/go/src/github.com/user/repo \
-v /var/run/docker.sock:/var/run/docker.sock \
-w /go/src/github.com/user/repo \
-e GITHUB_TOKEN \
-e DOCKER_USERNAME \
-e DOCKER_PASSWORD \
-e DOCKER_REGISTRY \
-e GORELEASER_KEY \
goreleaser/goreleaser-pro release
!!! info Currently, the provided docker image does not support the generation of snapcraft packages.
Note that the image will almost always have the last stable Go version.
The DOCKER_REGISTRY environment variable can be left empty when you are
releasing to the public docker registry.
If you need more things, you are encouraged to keep your own image. You can always use GoReleaser's own Dockerfile as an example though and iterate from that.
Compiling from source
Here you have two options:
If you want to contribute to the project, please follow the steps on our contributing guide.
If you just want to build from source for whatever reason, follow these steps:
clone:
git clone https://github.com/goreleaser/goreleaser
cd goreleaser
get the dependencies:
go mod tidy
build:
go build -o goreleaser .
verify it works:
./goreleaser --version