Upgrade goreleaser to v2 #23703

sgress454 · 2024-11-11T23:18:02Z

Checklist for submitter

This PR updates Goreleaser to version 2. Updates include:

Upgrading the goreleaser dependency to v2
Updating CLI args in workflows in accordance with the upgrade guide
Updating goreleaser YML files, also in accordance with the upgrade guide
Small code update needed due to changes in the underlying nfpm package (the ExpandContentGlobs method was replaced by PrepareForPackager). The fact that this change wasn't considered a breaking change makes me think that we may be relying on a private API here.

I was able to run the Docker Publish workflow successfully on this branch. The Gorelease Orbit workflow runs successfully for MacOS, Linux and Linux-arm64, but fails on Windows due to it not knowing how to parse the tag name. I'm pushing a small patch to this branch that should allow tags like v1.36.0-1-some-notes to allow prerelease tags with notes. I wouldn't merge this before seeing that pass.

sgress454 · 2024-11-11T23:18:56Z

.github/workflows/goreleaser-fleet.yaml

-          args: release --rm-dist -f .goreleaser.yml
+          version: "~> 2"
+          args: release --clean -f .goreleaser.yml


see https://goreleaser.com/deprecations/#-rm-dist

sgress454 · 2024-11-11T23:19:52Z

.github/workflows/goreleaser-orbit.yaml


      - name: Run GoReleaser
-        run: go run github.com/goreleaser/goreleaser@56c9d09a1b925e2549631c6d180b0a1c2ebfac82 release --debug --rm-dist --skip-publish -f orbit/goreleaser-macos.yml # v1.20.0
+        run: go run github.com/goreleaser/goreleaser/v2@606c0e724fe9b980cd01090d08cbebff63cd0f72 release --verbose --clean --skip=publish -f orbit/goreleaser-macos.yml # v1.20.0


See https://goreleaser.com/deprecations/#-debug

sgress454 · 2024-11-11T23:24:09Z

.goreleaser.yml

-  name_template: "{{ .Tag }}-untagged"
+  version_template: "{{ .Tag }}-untagged"


See https://goreleaser.com/deprecations/#snapshotname_template

sgress454 · 2024-11-11T23:24:38Z

.goreleaser.yml

-  skip: true
+  disable: true


See https://goreleaser.com/deprecations/#changelogskip

sgress454 · 2024-11-12T04:26:47Z

orbit/pkg/packaging/deb.go

@@ -5,5 +5,5 @@ import "github.com/goreleaser/nfpm/v2/deb"
 // BuildDeb builds a .deb package
 // Note: this function is not safe for concurrent use
 func BuildDeb(opt Options) (string, error) {
-	return buildNFPM(opt, deb.Default)
+	return buildNFPM(opt, deb.Default, "deb")


Needed as the replacement for ExpandContentGlobs (i.e. PrepareForPackager) expects the name of the packager to be passed in, and I didn't see a way to get it from the packager var itself.

sgress454 · 2024-11-12T04:33:19Z

orbit/pkg/packaging/linux_shared.go

@@ -192,7 +193,7 @@ func buildNFPM(opt Options, pkger nfpm.Packager) (string, error) {
 		contents = append(contents, (&files.Content{
 			Destination: emptyFolder,
 			Type:        "dir",
-		}).WithFileInfoDefaults())
+		}).WithFileInfoDefaults(0o0, time.Now()))


WithFileInfoDefaults now expects a umask and an mtime to use if the file info doesn't include permissions or timestamp data. Since we weren't using this before, I'm providing a umask that's a no-op and a fallback mtime of "now" since that's what it did before. Since these are new folders I don't think this should cause any problems (the umask is intended to provide sane permissions in cases where a user may have changed perms on a file locally before adding it to a package).

sgress454 · 2024-11-12T04:34:08Z

orbit/pkg/packaging/windows.go

@@ -403,7 +403,7 @@ func SanitizeVersion(version string) ([]string, error) {
 	}
 	if len(vParts) == 3 && strings.Contains(vParts[2], "-") {
 		parts := strings.SplitN(vParts[2], "-", 2)
-		if len(parts) != 2 || parts[0] == "" || parts[1] == "" {
+		if len(parts) < 2 || parts[0] == "" || parts[1] == "" {


Intended to allow versions like orbit-v.1.2.3-1-some-notes-about-the-prerelease, where previously the notes part would have caused an error.

sgress454 · 2024-11-12T04:36:20Z

orbit/pkg/packaging/linux_shared.go

-			Destination: "/",
+			Destination: "",


Without this, we now get content collision errors as the behavior has changed for destinations ending in slashes. See goreleaser/nfpm#671 and goreleaser/nfpm#576.

mna

Didn't realize this was still a draft when I got the notification, but oh well might as well post my review. Changes LGTM but I'm not super familiar with the goreleaser build, might want to also wait for a review by someone who knows it better (I think Lucas might?).

mna · 2024-11-12T13:19:48Z

go.mod

 	github.com/go-ini/ini v1.67.0
 	github.com/go-kit/kit v0.12.0
 	github.com/go-kit/log v0.2.1
 	github.com/go-ole/go-ole v1.2.6
-	github.com/go-sql-driver/mysql v1.7.1
+	github.com/go-sql-driver/mysql v1.8.1


Just calling this out as there are some important version upgrades in this PR (scanning those quickly, the mysql driver might be the big one), we should make sure to do some smoke tests in QA once this lands in addition to automated tests.

mna · 2024-11-12T13:21:57Z

orbit/pkg/packaging/linux_shared.go

@@ -19,7 +20,7 @@ import (
 	"github.com/rs/zerolog/log"
 )

-func buildNFPM(opt Options, pkger nfpm.Packager) (string, error) {
+func buildNFPM(opt Options, pkger nfpm.Packager, packagerName string) (string, error) {


Nit, but would it be clearer as to what to pass with packagerType or packagerExt?

sgress454 · 2024-11-12T14:44:58Z

@mna

Didn't realize this was still a draft when I got the notification, but oh well might as well post my review. Changes LGTM but I'm not super familiar with the goreleaser build, might want to also wait for a review by someone who knows it better (I think Lucas might?).

np I moved it back to draft when I saw that tests were failing. But re: the mysql and other dependency upgrades, they don't seem to be necessarily related to goreleaser and I think they're likely related to the test failures considering this PR doesn't update any functional code. So I'm going to back those out and try to update only goreleaser-related dependencies.

sgress454 · 2024-11-12T21:18:29Z

Closing this in favor of #23748 which doesn't require code changes.

sgress454 added 12 commits November 7, 2024 14:40

add workflow

0fcd435

launch on push

a0c86ec

try again

10b78c9

base64?

02a80a0

Update to goreleaser 2

701ea05

remove action

1543f57

updates for nfpm 2

141614c

orbit test

43a017d

run action on branch

3c952f3

snapshot in test

e8e16d5

remove test workflow

75f4b79

allow rc versions w/ notes like v1.2.3-1-do-the-funky-chicken

595a204

sgress454 requested review from lukeheath, georgekarrv, sharon-fdm and a team as code owners November 11, 2024 23:18

sgress454 temporarily deployed to Docker Hub November 11, 2024 23:18 — with GitHub Actions Inactive

sgress454 commented Nov 11, 2024

View reviewed changes

sgress454 marked this pull request as draft November 11, 2024 23:25

fix glob destination

7c0ad5e

sgress454 temporarily deployed to Docker Hub November 12, 2024 04:21 — with GitHub Actions Inactive

sgress454 commented Nov 12, 2024

View reviewed changes

check error

7b4169d

sgress454 temporarily deployed to Docker Hub November 12, 2024 04:38 — with GitHub Actions Inactive

mna approved these changes Nov 12, 2024

View reviewed changes

Merge branch 'main' into 19530-upgrade-goreleaser-to-v2

9e05a55

sgress454 temporarily deployed to Docker Hub November 12, 2024 14:12 — with GitHub Actions Inactive

sgress454 mentioned this pull request Nov 12, 2024

Use goreleaser v2 in CI #23748

Merged

sgress454 closed this Nov 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade goreleaser to v2 #23703

Upgrade goreleaser to v2 #23703

sgress454 commented Nov 11, 2024

sgress454 Nov 11, 2024

sgress454 Nov 11, 2024

sgress454 Nov 11, 2024

sgress454 Nov 11, 2024

sgress454 Nov 12, 2024

sgress454 Nov 12, 2024

sgress454 Nov 12, 2024

sgress454 Nov 12, 2024 •

edited

Loading

mna left a comment

mna Nov 12, 2024

mna Nov 12, 2024

sgress454 commented Nov 12, 2024

sgress454 commented Nov 12, 2024 •

edited

Loading

		name_template: "{{ .Tag }}-untagged"
		version_template: "{{ .Tag }}-untagged"

Upgrade goreleaser to v2 #23703

Upgrade goreleaser to v2 #23703

Conversation

sgress454 commented Nov 11, 2024

Checklist for submitter

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgress454 Nov 12, 2024 • edited Loading

Choose a reason for hiding this comment

mna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sgress454 commented Nov 12, 2024

sgress454 commented Nov 12, 2024 • edited Loading

sgress454 Nov 12, 2024 •

edited

Loading

sgress454 commented Nov 12, 2024 •

edited

Loading