Deprecation notices - Goreleaser

This page is used to list deprecation notices across GoReleaser.

Deprecated options are only removed on major versions of GoReleaser. Deprecated versions on features deemed experimental (you see a warning when using them) might be removed in feature releases.

Nevertheless, it's a good thing to keep your configuration up-to-date to prevent any issues.

You can check your use of deprecated configurations by running:

goreleaser check

Active deprecation notices

dockers_v2.retry

since v2.15.3

All retry configuration was moved to the root of the configuration file:

yaml

dockers_v2:
  - retry:
      attempts: 3
      delay: 5s
      max_delay: 1m

yaml

retry:
  attempts: 3
  delay: 5s
  max_delay: 1m

docker_manifests.retry

since v2.15.3

All retry configuration was moved to the root of the configuration file:

yaml

docker_manifests:
  - retry:
      attempts: 3
      delay: 5s
      max_delay: 1m

yaml

retry:
  attempts: 3
  delay: 5s
  max_delay: 1m

dockers.retry

since v2.15.3

All retry configuration was moved to the root of the configuration file:

yaml

dockers:
  - retry:
      attempts: 3
      delay: 5s
      max_delay: 1m

yaml

retry:
  attempts: 3
  delay: 5s
  max_delay: 1m

furies

since v2.14

furies was renamed to gemfury for clarity.

yaml

furies:
  - account: myaccount

yaml

gemfury:
  - account: myaccount

mcp.github

since v2.13.1

The MCP configuration was initially nested under github, but the registry is actually run by the MCP committee, not GitHub specifically. The configuration should now be at the top level of mcp.

yaml

mcp:
  github:
    name: io.github.user/myserver
    title: "My MCP Server"
    description: "MCP server for my project"
    # ...

yaml

mcp:
  name: io.github.user/myserver
  title: "My MCP Server"
  description: "MCP server for my project"
  # ...

homebrew_casks.binary

since v2.12.6

It should now be in plural form.

yaml

homebrew_casks:
  - binary: foo

yaml

homebrew_casks:
  - binaries: [foo]

dockers

We're re-implementing the docker feature from the ground up.

The configuration now is way more concise, and the implementation is simpler as well.

Before, you would have to setup dockers and docker_manifests, now, only dockers (provisionally being called dockers_v2) is needed to achieve the same things.

Then, instead of building the images, pushing them, and then building the manifests and pushing them, we will now run a single docker buildx build with the given platforms, which will build and publish the manifest and SBOM.

yaml

dockers:
  - image_templates:
      - "foo/bar:v{{ .Version }}-amd64"
      - "ghcr.io/foo/bar:v{{ .Version }}-amd64"
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - "--pull"
      - "--label=org.opencontainers.image.description=Foo bar"
      - "--label=org.opencontainers.image.created={{.Date}}"
      - "--label=org.opencontainers.image.name={{.ProjectName}}"
      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
      - "--label=org.opencontainers.image.version={{.Version}}"
      - "--label=org.opencontainers.image.source={{.GitURL}}"
      - "--platform=linux/amd64"
  - image_templates:
      - "foo/bar:v{{ .Version }}-arm64"
      - "ghcr.io/foo/bar:v{{ .Version }}-arm64"
    dockerfile: Dockerfile
    use: buildx
    build_flag_templates:
      - "--pull"
      - "--label=org.opencontainers.image.description=Foo bar"
      - "--label=org.opencontainers.image.created={{.Date}}"
      - "--label=org.opencontainers.image.name={{.ProjectName}}"
      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
      - "--label=org.opencontainers.image.version={{.Version}}"
      - "--label=org.opencontainers.image.source={{.GitURL}}"
      - "--platform=linux/arm64"
    goarch: arm64

docker_manifests:
  - name_template: "foo/bar:v{{ .Version }}"
    image_templates:
      - "foo/bar:v{{ .Version }}-amd64"
      - "foo/bar:v{{ .Version }}-arm64"
  - name_template: "ghcr.io/foo/bar:v{{ .Version }}"
    image_templates:
      - "ghcr.io/foo/bar:v{{ .Version }}-amd64"
      - "ghcr.io/foo/bar:v{{ .Version }}-arm64"
  - name_template: "{{ if not .IsNightly }}foo/bar:latest{{ end }}"
    image_templates:
      - "foo/bar:v{{ .Version }}-amd64"
      - "foo/bar:v{{ .Version }}-arm64"
  - name_template: "{{ if not .IsNightly }}ghcr.io/foo/bar:latest{{ end }}"
    image_templates:
      - "ghcr.io/foo/bar:v{{ .Version }}-amd64"
      - "ghcr.io/foo/bar:v{{ .Version }}-arm64"
  - name_template: "{{ if .IsNightly }}foo/bar:nightly{{ end }}"
    image_templates:
      - "foo/bar:v{{ .Version }}-amd64"
      - "foo/bar:v{{ .Version }}-arm64"
  - name_template: "{{ if .IsNightly }}ghcr.io/foo/bar:nightly{{ end }}"
    image_templates:
      - "ghcr.io/foo/bar:v{{ .Version }}-amd64"
      - "ghcr.io/foo/bar:v{{ .Version }}-arm64"

yaml

dockers_v2:
  - images:
      - "foo/bar"
      - "ghcr.io/foo/bar"
    tags:
      - "v{{ .Version }}"
      - "{{ if .IsNightly }}nightly{{ end }}"
      - "{{ if not .IsNightly }}latest{{ end }}"
    labels:
      "org.opencontainers.image.description": "Foo bar"
      "org.opencontainers.image.created": "{{.Date}}"
      "org.opencontainers.image.name": "{{.ProjectName}}"
      "org.opencontainers.image.revision": "{{.FullCommit}}"
      "org.opencontainers.image.version": "{{.Version}}"
      "org.opencontainers.image.source": "{{.GitURL}}"

As you can see, it's a lot simpler. The resulting images are the same, a combination of all the non-empty images with all the non-empty tags.

This will also require a small change in your Dockerfile when copying from the context:

dockerfile

FROM alpine
COPY my-binary /usr/bin

dockerfile

FROM alpine
ARG TARGETPLATFORM
COPY $TARGETPLATFORM/my-binary /usr/bin

GoReleaser will automatically setup the context in such a way that all the artifacts for the given target platform will be located within $TARGETPLATFORM/.

When running a --snapshot build, GoReleaser will append the platform to the tags, and will create Docker images instead of manifests, as manifests can't be created without pushing.

Feel free to suggest improvements here.

Regarding signing, you may also remove the artifacts option from you docker_signs:

yaml

docker_signs:
  - artifacts: images
    # etc..

yaml

docker_signs:
  -  # etc..

Since in the future we'll only have the docker image type, the artifacts property will eventually be deprecated and removed.

homebrew_casks.conflicts.formula

since v2.12

It was a no-op before, and is now removed from Homebrew.

yaml

homebrew_casks:
  - conflicts:
      - formula: foo

yaml

homebrew_casks:
  - {}

homebrew_casks.manpage

since v2.11

You may now define multiple man pages, which was not possible in v2.10.

yaml

homebrew_casks:
  - manpage: foo.1.gz

yaml

homebrew_casks:
  - manpages:
      - foo.1.gz

brews

since v2.10

Historically, GoReleaser would generate hackyish formulas that would install the pre-compiled binaries. This was the only way to do it for Linuxbrew at the time, but this is no longer true, and Casks should be used instead.

That said, we now have a homebrew_casks section!

For simple cases, simply replacing one with the other will be good enough. More complex settings might require further change. Check the new documentation for more details.

Once you do the first release this way, you might also want to delete the old Formulas from your Tap. You may also want to make the Cask conflict with the previous Formula.

yaml

brews:
  - name: foo
    directory: Formulas

yaml

homebrew_casks:
  - name: foo
    # Optional: either set it to Casks, or remove it:
    directory: Casks

    # Optional: helps pass `homebrew audit` if homepage is different from download domain:
    url:
      verified: github.com/myorg/myrepo

    # Optional: if your app/binary isn't signed and notarized, you'll need this:
    hooks:
      post:
        # replace foo with the actual binary name
        install: |
          if OS.mac?
            system_command "/usr/bin/xattr", args: ["-dr", "com.apple.quarantine", "#{staged_path}/foo"]
          end

[!WARNING] Don't forget to remove the directory: Formula from your configuration. Casks need to be in the Casks directory - which is the default.

The preferred way to migrate is to create a tap_migrations.json file in the root of your tap:

json

{
  "foo": "foo"
}

And then delete the Formula:

rm Formula/foo.rb

With this, when the user tries to upgrade, it should automatically update to the Cask instead.

archives.builds

since v2.8

The builds field has been replaced with the ids, which is the nomenclature used everywhere else.

yaml

archives:
  builds: [a, b]

yaml

archives:
  ids: [a, b]

snaps.builds

since v2.8

The builds field has been replaced with the ids, which is the nomenclature used everywhere else.

yaml

snaps:
  builds: [a, b]

yaml

snaps:
  ids: [a, b]

nfpms.builds

since v2.8

The builds field has been replaced with the ids, which is the nomenclature used everywhere else.

yaml

nfpms:
  builds: [a, b]

yaml

nfpms:
  ids: [a, b]

archives.format

since v2.6

Format was renamed to formats, and now accepts a list of formats.

yaml

archives:
  - format: zip

yaml

archives:
  - formats: ["zip"]

[!NOTE] It will still accept a single string, e.g.: formats: zip. In most cases you can simply rename the property to formats.

archives.format_overrides.format

since v2.6

Format was renamed to formats, and now accepts a list of formats.

[!NOTE] It will still accept a single string, e.g.: formats: zip. In most cases you can simply rename the property to formats.

yaml

archives:
  - format_overrides:
      - format: zip

yaml

archives:
  - format_overrides:
      - formats: ["zip"]

[!NOTE] It will still accept a single string, e.g.: formats: zip. In most cases you can simply rename the property to formats.

kos.repository

since v2.5

Use repositories instead. It allows to create multiple images with Ko, without having to rebuild each of them.

yaml

kos:
  - repository: foo/bar

yaml

kos:
  - repositories:
      - foo/bar

builds.gobinary

since v2.5

The property was renamed to tool, as to better accommodate multiple languages.

yaml

builds:
  - gobinary: "go1.2.3"

yaml

builds:
  - tool: "go1.2.3"

kos.sbom

since v2.2

Ko removed support for cyclonedx and go.version-m SBOMs from upstream. You can now either use spdx or none. From now on, these two options will be replaced by none. We recommend you change it to spdx.

nightly.name_template

since v2.2

Property renamed so its easier to reason about.

yaml

nightly:
  name_template: "foo"

yaml

nightly:
  version_template: "foo"

snapshot.name_template

since v2.2

Property renamed so its easier to reason about.

yaml

snapshot:
  name_template: "foo"

yaml

snapshot:
  version_template: "foo"

Removed in v2

archives.strip_parent_binary_folder

since 2024-03-29 (v1.25), removed 2024-05-26 (v2.0)

Property was renamed to be consistent across all configurations.

yaml

archives:
  - strip_parent_binary_folder: true

yaml

archives:
  - strip_binary_directory: true

blobs.folder

since 2024-03-29 (v1.25), removed 2024-05-26 (v2.0)

Property was renamed to be consistent across all configurations.

yaml

blobs:
  - folder: foo

yaml

blobs:
  - directory: foo

brews.folder

since 2024-03-29 (v1.25), removed 2024-05-26 (v2.0)

Property was renamed to be consistent across all configurations.

yaml

brews:
  - folder: foo

yaml

brews:
  - directory: foo

scoops.folder

since 2024-03-29 (v1.25), removed 2024-05-26 (v2.0)

Property was renamed to be consistent across all configurations.

yaml

scoops:
  - folder: foo

yaml

scoops:
  - directory: foo

furies.skip

since 2024-03-03 (v1.25), removed 2024-05-26 (v2.0)

Changed to disable to conform with all other pipes.

yaml

furies:
  - skip: true

yaml

furies:
  - disable: true

changelog.skip

since 2024-01-14 (v1.24), removed 2024-05-26 (v2.0)

Changed to disable to conform with all other pipes.

yaml

changelog:
  skip: true

yaml

changelog:
  disable: true

blobs.kmskey

since 2024-01-07 (v1.24), removed 2024-05-26 (v2.0)

Changed to kms_key to conform with all other options.

yaml

blobs:
  - kmskey: foo

yaml

blobs:
  - kms_key: foo

blobs.disableSSL

since 2024-01-07 (v1.24), removed 2024-05-26 (v2.0)

Changed to disable_ssl to conform with all other options.

yaml

blobs:
  - disableSSL: true

yaml

blobs:
  - disable_ssl: true

`--skip`

since 2023-09-14 (v1.21), removed 2024-05-26 (v2.0)

The following goreleaser release flags were deprecated:

--skip-announce
--skip-before
--skip-docker
--skip-ko
--skip-publish
--skip-sbom
--skip-sign
--skip-validate

By the same token, the following goreleaser build flags were deprecated:

--skip-before
--skip-post-hooks
--skip-validate

All these flags are now under a single --skip flag, that accepts multiple values.

goreleaser build --skip-before --skip-validate
goreleaser release --skip-validate --skip-publish

goreleaser build --skip=before,validate
goreleaser release --skip=validate,publish

# or

goreleaser build --skip=before --skip=validate
goreleaser release --skip=validate --skip=publish

You can check goreleaser build --help and goreleaser release --help to see the valid options, and shell autocompletion should work properly as well.

scoops.bucket

since 2023-06-13 (v1.19.0), removed 2024-05-26 (v2.0)

Replace bucket with repository.

yaml

scoops:
  - bucket:
      - name: foo
        owner: bar

yaml

scoops:
  - repository:
      - name: foo
        owner: bar

krews.index

since 2023-06-13 (v1.19.0), removed 2024-05-26 (v2.0)

Replace index with repository.

yaml

krews:
  - index:
      - name: foo
        owner: bar

yaml

krews:
  - repository:
      - name: foo
        owner: bar

brews.tap

since 2023-06-13 (v1.19.0), removed 2024-05-26 (v2.0)

Replace tap with repository.

yaml

brews:
  - tap:
      - name: foo
        owner: bar

yaml

brews:
  - repository:
      - name: foo
        owner: bar

archives.rlcp

since 2023-06-06 (v1.19.0), removed 2024-05-26 (v2.0)

This option is now default and can't be changed. You can remove it from your configuration files.

source.rlcp

since 2023-06-06 (v1.19.0), removed 2024-05-26 (v2.0)

This option is now default and can't be changed. You can remove it from your configuration files.

brews.plist

since 2023-06-06 (v1.19.0), removed 2024-05-26 (v2.0)

plist is deprecated by Homebrew, and now on GoReleaser too. Use service instead.

yaml

brews:
  - plist: |
      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
      <plist version="1.0">
      <dict>
      # etc ...

yaml

brews:
  - service: |
      run [opt_bin/"mybin"]
      keep_alive true
      # etc ...

--debug

since 2023-05-16 (v1.19.0), removed 2024-05-26 (v2.0)

--debug has been deprecated in favor of --verbose.

bash

goreleaser release --debug

bash

goreleaser release --verbose

scoop

since 2023-04-30 (v1.18.0), removed 2024-05-26 (v2.0)

GoReleaser now allows many scoop configurations, so it should be pluralized accordingly.

yaml

scoop:
  # ...

yaml

scoops:
  -  # ...

build

since 2023-02-09 (v1.16.0), removed 2024-05-26 (v2.0)

This option was still being supported, even though undocumented, for a couple of years now. It's finally time to sunset it.

Simply use the pluralized form, builds, according to the documentation.

yaml

build:
  # ...

yaml

builds:
  -  # ...

--rm-dist

since 2023-01-17 (v1.15.0), removed 2024-05-26 (v2.0)

--rm-dist has been deprecated in favor of --clean.

bash

goreleaser release --rm-dist

bash

goreleaser release --clean

nfpms.maintainer

since 2022-05-07 (v1.9.0), removed 2024-05-26 (v2.0)

nFPM will soon make mandatory setting the maintainer field.

yaml

nfpms:
  - maintainer: ""

yaml

nfpms:
  - maintainer: "Name <email>"