Back to Goreleaser

Install GoReleaser

www/content/getting-started/install/oss.md

2.18.17.6 KB
Original Source

{{< cards cols="2" >}} {{< card link="https://github.com/goreleaser/goreleaser/releases/tag/__VERSION__" title="Latest stable" subtitle="__VERSION__" >}} {{< card link="https://github.com/goreleaser/goreleaser/releases/nightly" title="Latest nightly" subtitle="<span data-nightly-tag data-repo='goreleaser/goreleaser'>loading…</span>" >}} {{< /cards >}}

See all releases on GitHub.

{{< g_install_versions >}}

Homebrew Tap

bash
brew install --cask goreleaser/tap/goreleaser

Homebrew

{{< badge content="Community Owned" icon="external-link" >}}

bash
brew install goreleaser

[!WARNING] The formula in homebrew-core might be slightly outdated. Use our homebrew tap to always get the latest updates.

NPM

bash
npm i -g @goreleaser/goreleaser

Snapcraft

bash
sudo snap install --classic goreleaser

Scoop

bash
scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install goreleaser

Chocolatey

{{< badge content="Community Owned" icon="external-link" >}}

bash
choco install goreleaser

Winget

bash
winget install goreleaser

Apt Repository

bash
echo 'deb [trusted=yes] https://repo.goreleaser.com/apt/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
sudo apt install goreleaser

Yum Repository

bash
echo '[goreleaser]
name=GoReleaser
baseurl=https://repo.goreleaser.com/yum/
enabled=1
gpgcheck=0
exclude=goreleaser-pro' | sudo tee /etc/yum.repos.d/goreleaser.repo
sudo yum install goreleaser

AUR

bash
yay -S goreleaser-bin

Nixpkgs

{{< badge content="Community Owned" icon="external-link" >}}

bash
nix-shell -p goreleaser

[!WARNING] The package in nixpkgs might be slightly outdated, as it is not updated automatically. Use our NUR to always get the latest updates.

NUR

First, you'll need to add our NUR to your Nix configuration. Follow the NUR installation guide.

Once you do that, you can install the packages.

nix
{ pkgs, lib, ... }: {
  home.packages = with pkgs; [
    nur.repos.goreleaser.goreleaser
  ];
}

Docker

Registries:

Example usage:

bash
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

[!WARNING] The provided Docker image does not support the Snapcraft feature.

The DOCKER_REGISTRY environment variable can be left empty when you are releasing to the public Docker registry.

If you need more than that, keep your own image. You can use the GoReleaser Dockerfile as a starting point.

[!NOTE] There are also :nightly tags available with the latest nightly builds.

Linux packages

Download the .deb, .rpm, or .apk packages from the releases page and install them with the appropriate tools.

{{% g_button href="https://github.com/goreleaser/goreleaser/releases/tag/__VERSION__" label="Download" icon="github" primary="true" %}}

To install, after downloading the files, run:

bash
dpkg -i goreleaser*.deb
rpm -ivh goreleaser*.rpm
apk add --allow-untrusted goreleaser*.apk

go install

bash
go install github.com/goreleaser/goreleaser/v2@latest

Requires Go 1.27.

Bash Script

This script does not install anything. It downloads, verifies, and runs GoReleaser, so you can use it in scripts and CI pipelines.

bash
curl -sfL https://goreleaser.com/static/run | VERSION=__VERSION__ bash -s -- check

[!NOTE] The VERSION environment variable can be omitted to get the latest stable version, or you can set it to nightly to get the last nightly build.

Manually

Download the pre-compiled binaries from the releases page and copy them to the desired location:

{{% g_button href="https://github.com/goreleaser/goreleaser/releases/tag/__VERSION__" label="Download" icon="github" primary="true" %}}

Verifying the artifacts

Binaries

Signatures

All artifacts are checksummed, and the checksum file is signed with cosign.

  1. Download the files you want, plus the checksums.txt and checksums.txt.sigstore.json files, from the releases page:

    bash
    wget 'https://github.com/goreleaser/goreleaser/releases/download/__VERSION__/checksums.txt'
    wget 'https://github.com/goreleaser/goreleaser/releases/download/__VERSION__/checksums.txt.sigstore.json'
    
  2. Verify the signature:

    bash
    cosign verify-blob \
      --certificate-identity 'https://github.com/goreleaser/goreleaser/.github/workflows/release.yml@refs/tags/__VERSION__' \
      --certificate-oidc-issuer 'https://token.actions.githubusercontent.com' \
      --bundle checksums.txt.sigstore.json \
      ./checksums.txt
    
  3. If the signature is valid, verify that the SHA256 sums match the downloaded binary:

    bash
    sha256sum --ignore-missing -c checksums.txt
    

Attestations

You can also verify the attestations:

bash
gh attestation verify --owner goreleaser *.tar.gz
# PS: can be any file from the release

Docker images

Our Docker images are signed with cosign.

Verify the signatures:

bash
cosign verify \
  --certificate-identity 'https://github.com/goreleaser/goreleaser/.github/workflows/release.yml@refs/tags/__VERSION__' \
  --certificate-oidc-issuer 'https://token.actions.githubusercontent.com' \
  goreleaser/goreleaser

SBOMs

Each archive has a Software Bill of Materials in SPDX JSON format, generated with Syft. The file name is the archive name plus the .sbom.json suffix.

Download them from the releases page:

{{% g_button href="https://github.com/goreleaser/goreleaser/releases/tag/__VERSION__" label="Download" icon="github" primary="true" %}}

For example, to get the SBOM of the Linux x86-64 archive:

bash
wget 'https://github.com/goreleaser/goreleaser/releases/download/__VERSION__/goreleaser_Linux_x86_64.tar.gz.sbom.json'

The SBOM files are also in checksums.txt, so you can verify them with the steps in Verifying the artifacts.

Nightly builds

Nightly builds are pre-releases of the current code in the main branch. Use them for testing out new features only.

Download the pre-compiled binaries from the nightly release and copy them to the desired location.

Docker images are also available, look for tags with a -nightly suffix for the last nightly of a specific release, or the :nightly tag, which is always the latest nightly build available.

You may also use the Bash Script method by setting the VERSION environment variable to nightly.

Community

Install options with the "Community Owned" badge are maintained by the community and might not always be up to date.