ContextQMD
Back to Goreleaser

GitHub Actions

www/content/customization/ci/actions.md

2.15.48.0 KB
Original Source

GoReleaser can also be used within our official GoReleaser Action through GitHub Actions.

You can create a workflow for pushing your releases by putting YAML configuration to .github/workflows/release.yml.

Usage

Workflow

Below is a simple snippet to use this action in your workflow:

yaml
name: goreleaser

on:
  pull_request:
  push:
    # run only against tags
    tags:
      - "*"

permissions:
  contents: write
  # packages: write
  # issues: write
  # id-token: write

jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: stable
      # More assembly might be required: Docker logins, GPG, etc.
      # It all depends on your needs.
      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v7
        with:
          # either 'goreleaser' (default) or 'goreleaser-pro'
          distribution: goreleaser
          # 'latest', 'nightly', or a semver
          version: "~> v2"
          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro' distribution
          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}

[!WARNING] Some things to look closely...

The action does not install, configure or authenticate into dependencies

GoReleaser Action will not install nor setup any other software needed to release. It's the user's responsibility to install and configure Go, Docker, Syft, Cosign and any other tools the release might need. It's also the user's responsibility to log in into tools that need it, such as docker.

Fetch all history

Notice the fetch-depth: 0 option in the Checkout workflow step. This is required for GoReleaser to work properly, as it will need the full history to work properly.

[!NOTE] For detailed instructions please follow GitHub Actions workflow syntax.

Signing

If signing is enabled in your GoReleaser configuration, you can use the Import GPG GitHub Action along with this one:

yaml
jobs:
  # ...
  goreleaser:
    # ...
    steps:
      # ...
      - name: Import GPG key
        id: import_gpg
        uses: crazy-max/ghaction-import-gpg@v6
        with:
          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
          passphrase: ${{ secrets.PASSPHRASE }}
      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v7
        with:
          version: "~> v2"
          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
      # ...

And reference the fingerprint in your signing configuration using the GPG_FINGERPRINT environment variable:

yaml
signs:
  - artifacts: checksum
    cmd: gpg2
    args:
      - "--batch"
      - "-u"
      - "{{ .Env.GPG_FINGERPRINT }}"
      - "--output"
      - "${signature}"
      - "--detach-sign"
      - "${artifact}"

Customizing

Inputs

Following inputs can be used as step.with keys

NameTypeDefaultDescription
distributionStringgoreleaserGoReleaser distribution, either goreleaser or goreleaser-pro
version1String~> v2GoReleaser version
argsStringArguments to pass to GoReleaser
workdirString.Working directory (below repository root)
install-onlyBoolfalseJust install GoReleaser

Outputs

Following outputs are available

NameTypeDescription
artifactsJSONBuild result artifacts
metadataJSONBuild result metadata

Environment Variables

Following environment variables can be used as step.env keys

NameDescription
GITHUB_TOKENGITHUB_TOKEN as provided by secrets
GORELEASER_KEYYour GoReleaser Pro License Key, in case you are using the goreleaser-pro distribution

Token Permissions

The following permissions are required by GoReleaser:

GITHUB_TOKEN permissions are limited to the repository that contains your workflow.

If you need to push the homebrew tap to another repository, you must create a custom Personal Access Token with repo permissions and add it as a secret in the repository. If you create a secret named GH_PAT, the step will look like this:

yaml
jobs:
  # ...
  goreleaser:
    # ...
    steps:
      # ...
      - name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v7
        with:
          version: "~> v2"
          args: release --clean
        env:
          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
      # ...

You can also read the GitHub documentation about it.

What does it look like?

You can check this example repository for a real world example.

Footnotes

  1. Can be a fixed version like v0.117.0 or a max satisfying SemVer one like ~> 0.132. In this case this will return v0.132.1. ↩