Add goreleaser #115

josvazg · 2021-12-13T11:22:24Z

Add goreleaser to a release GitHub action and disable versioning and release code from runway CI.

Tested on a separate repo to check out how releases would look like in the GitHub releases page.

josvazg · 2021-12-13T14:24:19Z

Keeps failing, not sure I can reproduce locally. Debugging...

josvazg · 2021-12-14T08:49:13Z

@tompizmor any clues on how can I void this stuttering?

binary=/home/runner/work/asset-relocation-tool-for-kubernetes/asset-relocation-tool-for-kubernetes/dist/asset-relocation-tool-for-kubernetes_darwin_arm64/relok8s

I'd rather have something like this:

binary=/home/runner/work/asset-relocation-tool-for-kubernetes/asset-relocation-tool-for-kubernetes/dist/relok8s_darwin_arm64/relok8s

Maybe I should fork this on my own repo to see how releases would look like in github before we merge in main. To avoid suprises.

.github/workflows/golangci-lint.yml

josvazg · 2021-12-15T16:15:04Z

BTW I branched this on my own private repo and I am playing with generating releases there, see how they look, if they autocreate tags, etc

.github/workflows/golangci-lint.yml

josvazg · 2021-12-15T19:04:58Z

Now I am blocked on how to make the version setting automation work well with tags. I was thinking we could remove the version file and list the last tag from git tag, but it does not seem so easy...

josvazg · 2021-12-15T19:06:54Z

Sample releases on my repo tests:

vmwclabot · 2021-12-16T08:10:02Z

@josvazg, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit de6a316 must be signed by josvaz@vmware.com
Commit 645859d must be signed by git@localhost
Commit f650953 must be signed by josvaz@vmware.com
Commit 929db9e must be signed by josvaz@vmware.com
Commit 10ee433 must be signed by git@localhost
Commit c346b45 must be signed by git@localhost
Commit f09e6ca must be signed by git@localhost
Commit f9af1f2 must be signed by josvazg@gmail.com
Commit c2f53bc must be signed by josvazg@gmail.com
Commit d14c2cc must be signed by josvazg@gmail.com
Commit 08cef09 must be signed by josvaz@vmware.com
Commit a2fcbee must be signed by josvazg@gmail.com
Commit 7085b02 must be signed by josvaz@vmware.com
Commit a5f2d55 must be signed by josvaz@vmware.com
Commit 1782aa9 must be signed by josvaz@vmware.com
Commit c1dccf4 must be signed by josvazg@gmail.com
Commit 2c3f082 must be signed by josvazg@gmail.com

vmwclabot · 2021-12-16T10:34:03Z

@josvazg, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit be6fc30 must be signed by josvaz@vmware.com

tompizmor · 2021-12-16T11:46:56Z

Now I am blocked on how to make the version setting automation work well with tags. I was thinking we could remove the version file and list the last tag from git tag, but it does not seem so easy...

Can't you use ldflags to set the version of the variable as it is done in charts-syncer?

.goreleaser.yml

tompizmor · 2021-12-16T11:48:31Z

@tompizmor any clues on how can I void this stuttering?
binary=/home/runner/work/asset-relocation-tool-for-kubernetes/asset-relocation-tool-for-kubernetes/dist/asset-relocation-tool-for-kubernetes_darwin_arm64/relok8s
I'd rather have something like this:
binary=/home/runner/work/asset-relocation-tool-for-kubernetes/asset-relocation-tool-for-kubernetes/dist/relok8s_darwin_arm64/relok8s
Maybe I should fork this on my own repo to see how releases would look like in github before we merge in main. To avoid suprises.

did you solve this already? actually I don't know where those paths are defined so I would need to check the documentation

vmwclabot · 2021-12-17T08:03:53Z

@josvazg, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 404db1e must be signed by josvaz@vmware.com

josvazg · 2021-12-17T08:14:44Z

Now I am blocked on how to make the version setting automation work well with tags. I was thinking we could remove the version file and list the last tag from git tag, but it does not seem so easy...

Can't you use ldflags to set the version of the variable as it is done in charts-syncer?

Yes, relok8s was using that already for setting the version inside the binary. The problem was that we were using a version file to track the version and fill ldflags, while goreleaser uses the tag. I tried to get rid of the version file, but it was problematic as I could not get a reliable last tag from git.
In the end I decided to keep the version file, so the version bumper script does the following:

Read the current version file to get the previous version.
Compile and run next-semver to:

Bump the version automatically, if the script was passed no arguments.
Or pass the user desired new version to use. The next-semver will complain if the desired version is not SemVer compliant or is considered before the previous version.

Update the version file with the new version.
Commit the version bump.
Git tag and push the new version as "v${version}".

I think this should work for us to have manual decided releases.

josvazg · 2021-12-17T08:17:22Z

BTW I noticed that there is something wrong with the ldflags trick here, I am passing the VERSION env var to goreleaser and this is supposedly using make to build the images, so that VERSION should be used to set the binary version with the ldflags, but it is NOT doing it for some reason, I still get the dev version.

And this is a PITA to test, as I need to do it on a separate private repo, to avoid polluting our releases here.

josvazg · 2021-12-17T08:18:26Z

did you solve this already? actually I don't know where those paths are defined so I would need to check the documentation

Looking at the final release, those paths do not really matter. Only the files are listed, like in the images I pasted. So I think I will not try to fix any of that.

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

josvazg · 2022-01-10T11:34:34Z

@petewall I tried to remove the CI code that handles and auto-bumps the version in commit 78c50a1
I most likely butchered the whole thing, so any help with that part would be appreciated.

migmartri · 2022-01-10T14:53:58Z

.goreleaser.yml

@@ -0,0 +1,35 @@
+# Make sure to check the documentation at https://goreleaser.com
+before:
+  hooks:


This does not look right. Are we also building the binary in the hook? What for?

I can try to remove. It will probably work anyways.
Seems goreleaser builds the binaries itself, does not like to rely on makefiles or anything.

migmartri · 2022-01-10T14:56:59Z

.goreleaser.yml

+      - -X github.com/vmware-tanzu/asset-relocation-tool-for-kubernetes/cmd.Version={{ .Version }}
+    goos:
+      - linux
+      - windows


windows? We don't support windows do we? https://github.com/vmware-tanzu/asset-relocation-tool-for-kubernetes/blob/main/Makefile#L79

I can remove

migmartri · 2022-01-10T15:00:08Z

.gitignore

@@ -8,3 +8,5 @@ build/*
 .idea
 *.iml

+


add a comment indicating that this is a directory of releases

# Releases

migmartri · 2022-01-10T15:05:13Z

bump-version.sh

@@ -0,0 +1,15 @@
+#!/bin/bash


Yeah, I guess we need to trust the operator that it's tagging a proper, valid version. We could also create the release a draft so it can be manually checked before releasing.

In any case, I kind of like how Kubeapps suggests to use some tooling to come up with a valid version, it's better than nothing. https://github.com/kubeapps/kubeapps/blob/master/docs/developer/release-process.md#2---create-a-git-tag

in following patches we should document our release process since now it has a manual component.

migmartri

Accepted although ptal at removing windows support and some other pieces of feedback. Thanks!

migmartri · 2022-01-10T15:06:29Z

.goreleaser.yml

+    binary: relok8s
+archives:
+  - replacements:
+      darwin: Darwin


this replacements to add capitalization does not feel right, in fact I do not like the filename resulting of it which uses underscore + Capitalized at the same time.

To me the only two replacements here should be the ones related to the arch

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

migmartri

From a quick check on the current pipeline and taking into account what in my opinion is the end goal (migrate to public CI), in this patch I think we are missing

Update build job to just build the docker image. In this case it might not make sense to build binaries since it has been delegated to goreleaser.
Update build job to stop writing the version file and releasing to github

I think we also need to revisit that last relocate-chart job since it's weird that it's not part of the external tests that we already have.

.goreleaser.yml

ci/pipeline.yaml

petewall · 2022-01-10T19:13:34Z

I'll take a peek at the concourse pipeline. Just to make sure I'm tracking the changes, what we want to do going forward is:

On every commit and on every PR:
- run the source test suite
On every new docker image from the registry:
- run the relocate-chart job

The reason I like keeping the relocate-chart job is not because it's adding anything to the other test suite, but because it's an easy demo example of using relok8s in a concourse pipeline.

… with new images Signed-off-by: Pete Wall <pwall@vmware.com>

josvazg · 2022-01-11T07:05:07Z

@migmartri yep that sounds reasonable, I will try to figure out the mapping between the pipeline graph and the yaml to make that happen.

@petewall yes, the idea for me is to remove in this PR anything from the CI code that we have moved to goreleaser & actions: build binaries and release, just as Miguel was mentioning. The rest can stay for now.

josvazg · 2022-01-11T07:09:20Z

BTW I am seeing a new transient issue in tests:

--- FAIL: TestGroupChangesByChart (0.00s)
panic: runtime error: index out of range [0] with length 0 [recovered]
	panic: runtime error: index out of range [0] with length 0

It happens sometimes, maybe it is a race condition?

josvazg · 2022-01-11T08:32:38Z

Just noticed that @petewall did the CI changes already.

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

josvazg · 2022-01-11T08:37:59Z

I added docs and fixed the latest cmment by @migmartri . As @petewall has fixed the CI pipeline, we can now mark this as ready to review.

josvazg requested review from migmartri, petewall and tompizmor December 13, 2021 11:22

josvazg self-assigned this Dec 13, 2021

josvazg marked this pull request as draft December 13, 2021 11:22

petewall reviewed Dec 14, 2021

View reviewed changes

.github/workflows/golangci-lint.yml Outdated Show resolved Hide resolved

migmartri suggested changes Dec 15, 2021

View reviewed changes

.github/workflows/golangci-lint.yml Outdated Show resolved Hide resolved

petewall approved these changes Dec 15, 2021

View reviewed changes

vmwclabot added the dco-required label Dec 16, 2021

josvazg force-pushed the add-goreleaser branch from 3cf8735 to d61d3cb Compare December 16, 2021 08:21

vmwclabot removed the dco-required label Dec 16, 2021

vmwclabot added the dco-required label Dec 16, 2021

josvazg force-pushed the add-goreleaser branch from 4e8e64b to 699f3c0 Compare December 16, 2021 10:39

vmwclabot removed the dco-required label Dec 16, 2021

josvazg linked an issue Dec 16, 2021 that may be closed by this pull request

Releases management #28

Closed

tompizmor reviewed Dec 16, 2021

View reviewed changes

.goreleaser.yml Outdated Show resolved Hide resolved

vmwclabot added the dco-required label Dec 17, 2021

Jose Luis Vazquez Gonzalez added 2 commits January 10, 2022 12:26

Remove version bump helpers

12b74a1

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Ensure goreleaser sets the binary version

71aef5f

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

josvazg force-pushed the add-goreleaser branch from c162528 to 71aef5f Compare January 10, 2022 11:26

Attempt to remove version handling from CI code

78c50a1

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

migmartri reviewed Jan 10, 2022

View reviewed changes

migmartri approved these changes Jan 10, 2022

View reviewed changes

Jose Luis Vazquez Gonzalez added 5 commits January 10, 2022 16:45

Add file copyright headers

9adfaef

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Add releases comment in gitignore for dist/

eab908f

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Do not use the makefile at all in goreleaser

1d4d407

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Do not build for Windows

880b8f1

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Do not rename OSs

9c87b65

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

josvazg requested review from tompizmor and petewall January 10, 2022 15:53

migmartri reviewed Jan 10, 2022

View reviewed changes

.goreleaser.yml Outdated Show resolved Hide resolved

ci/pipeline.yaml Outdated Show resolved Hide resolved

Change pipeline to only test source changes and run the CI relocation…

c4d0be3

… with new images Signed-off-by: Pete Wall <pwall@vmware.com>

Jose Luis Vazquez Gonzalez added 2 commits January 11, 2022 09:33

Use defaault goos

a3b669b

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

Document manual releases

03ad096

Signed-off-by: Jose Luis Vazquez Gonzalez <josvaz@vmware.com>

josvazg marked this pull request as ready for review January 11, 2022 08:38

jotadrilo approved these changes Jan 11, 2022

View reviewed changes

josvazg merged commit 19f99da into main Jan 11, 2022

migmartri deleted the add-goreleaser branch January 11, 2022 10:37

This was referenced Jan 11, 2022

Tags should start with v #108

Closed

Migrate CI pipeline to public instance #25

Open

chore: Cleanup tags and feature branches #129

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add goreleaser #115

Add goreleaser #115

josvazg commented Dec 13, 2021 •

edited

Loading

josvazg commented Dec 13, 2021

josvazg commented Dec 14, 2021

josvazg commented Dec 15, 2021

josvazg commented Dec 15, 2021 •

edited

Loading

josvazg commented Dec 15, 2021

vmwclabot commented Dec 16, 2021

vmwclabot commented Dec 16, 2021

tompizmor commented Dec 16, 2021 •

edited by josvazg

Loading

tompizmor commented Dec 16, 2021

vmwclabot commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Jan 10, 2022 •

edited

Loading

migmartri Jan 10, 2022

josvazg Jan 10, 2022

josvazg Jan 10, 2022

migmartri Jan 10, 2022

josvazg Jan 10, 2022

josvazg Jan 10, 2022

migmartri Jan 10, 2022

josvazg Jan 10, 2022

migmartri Jan 10, 2022

migmartri left a comment

migmartri Jan 10, 2022

josvazg Jan 10, 2022

migmartri left a comment

petewall commented Jan 10, 2022 •

edited

Loading

josvazg commented Jan 11, 2022 •

edited

Loading

josvazg commented Jan 11, 2022

josvazg commented Jan 11, 2022

josvazg commented Jan 11, 2022

Add goreleaser #115

Add goreleaser #115

Conversation

josvazg commented Dec 13, 2021 • edited Loading

josvazg commented Dec 13, 2021

josvazg commented Dec 14, 2021

josvazg commented Dec 15, 2021

josvazg commented Dec 15, 2021 • edited Loading

josvazg commented Dec 15, 2021

vmwclabot commented Dec 16, 2021

vmwclabot commented Dec 16, 2021

tompizmor commented Dec 16, 2021 • edited by josvazg Loading

tompizmor commented Dec 16, 2021

vmwclabot commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Dec 17, 2021

josvazg commented Jan 10, 2022 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

migmartri left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

migmartri left a comment

Choose a reason for hiding this comment

petewall commented Jan 10, 2022 • edited Loading

josvazg commented Jan 11, 2022 • edited Loading

josvazg commented Jan 11, 2022

josvazg commented Jan 11, 2022

josvazg commented Jan 11, 2022

josvazg commented Dec 13, 2021 •

edited

Loading

josvazg commented Dec 15, 2021 •

edited

Loading

tompizmor commented Dec 16, 2021 •

edited by josvazg

Loading

josvazg commented Jan 10, 2022 •

edited

Loading

petewall commented Jan 10, 2022 •

edited

Loading

josvazg commented Jan 11, 2022 •

edited

Loading