Automate releases #334

k0da · 2021-03-01T13:57:28Z

* Adds separate Dockerfile for each architecture to keep base image
  unchanged.
* Brings github_changelog_generator into a release pipeline
* Add .goreleaser.yaml with go build and amd64/arm64 images with docker
  common manifest
* Introduce pipeline for tag event, where docker artifacts will be
  built.
* Rename helm pipeline (release) into helm_publish

Signed-off-by: Dinar Valeev dinar.valeev@absa.africa

ytsarev · 2021-03-01T14:05:43Z

@somaritane keen to release v0.7.6 using this one?

UPD: ok, too late :D

ytsarev

Looks super fancy, just some clarifications required

ytsarev · 2021-03-01T14:09:27Z

.goreleaser.yml

+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'


Why exclude them?

This is upstream behaviour and ignored by providing --release-notes flag, https://goreleaser.com/customization/release/#custom-release-notes

I get it, just don't think we should exclude docs or tests from the changelog :)

ytsarev · 2021-03-01T14:10:16Z

.goreleaser.yml

+docker_manifests:
+- name_template: absaoss/k8gb:{{ .Tag }}
+  image_templates:
+  - absaoss/k8gb:{{ .Tag }}-amd64


Will the final tag include $arch suffix?

If yes, it will break this logic https://github.com/AbsaOSS/k8gb/blob/master/chart/k8gb/templates/operator.yaml#L29

It follows same strategy as of now. We build two images imag-{.Arch} then wrap it with single manifest name_template: absaoss/k8gb:{{ .Tag }}

So it won't break Deployment manifest. absaoss/k8gb:{{ .Tag }} will resolve into absaoss/k8gb:{{ .Tag }}-amd64 if kubernetes worker is amd64

ytsarev · 2021-03-01T14:10:29Z

.goreleaser.yml

+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"


Can you elaborate on the logic here?

you can run goreleaser --snapshot, it will build image: image:tag-next

I was wrong on publish: https://goreleaser.com/customization/snapshots/#how-it-works

somaritane · 2021-03-01T14:13:54Z

@somaritane keen to release v0.7.6 using this one?

@ytsarev, Oops, I've just released v0.7.6 now, but v0.7.7 - definitely :)

ytsarev · 2021-03-01T15:22:37Z

@k0da will it create Draft Release or Release right away?

k0da · 2021-03-01T15:33:35Z

If set to true, will not auto-publish the release.

Default is false.

draft: false

Release straighaway. I think we should start with draft first

somaritane · 2021-03-01T15:40:26Z

I think we should start with draft first

Makes sense. github-changelog-generator uses GH issue's tags for changelog generation, which might require 2nd pair of eyes to check that issues are correctly categorized

k0da · 2021-03-01T15:47:39Z

amended

ytsarev

@k0da what about we create some fake releases and see how it works end-to-end?

ytsarev · 2021-03-01T20:08:31Z

.goreleaser.yml

+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  sort: asc


is it about goreleaser based changelog? Will it be completely overriden by github_changelog_genererator? If yes we probably can omit this option

Yes, I'll drop it.

k0da · 2021-03-02T06:58:15Z

@k0da what about we create some fake releases and see how it works end-to-end?

I can tag local commit with v0.7.7-alpha1 and run releaser manually?

ytsarev

https://github.com/AbsaOSS/k8gb/releases/tag/untagged-d1d7bd1b09241abe6eb0 looks great, so let's accommodate the cool pipes :)

somaritane

lgtm

ytsarev · 2021-03-02T14:55:36Z

.gitignore

@@ -109,3 +109,6 @@ chart/k8gb/charts/*.tgz

 # Ignore testing kubeconfigs
 kubeconfig*
+
+# Ignore changes from github_changelog_generator action
+changes


How do we update CHANGELOG.md in this scenario?

same way as before, post release commit (post release github_changelog_generator on maintainers machine and open PR).
During GH run only temporary diff is generated into gitingored file.

But before local github_changelog_generator diff was the input for release. Now it will be required to run it locally post release and commit? It might lead to deviations

If I look at last v0.7.6 release, offline changelog was commited at 18:00, and release was done on 15:06. I see no deviation.

yeas, because offline changelog is the source for release text

Is it worth to sacrafice automation in order to have "offline" change log?
you have two tags, and tool to work with those tags. ATM we run tool get output and paste it into "Release".
I propose to run tool as part of release draft pipeline to format a release. Then run tool with same input to commit post release offline changelog. Sorry I only see an improvement here.

Additionally draft can be changed the same way from "offline" changelog.

I am not talking about sticking to current scenario, more thinking of avoiding pitfalls with the new one. Can we write to CHANGELOG.md in post-release pipeline and commit it automatically?

This option can be explored for sure.

@ytsarev ammended

@k0da very cool, thanks!

ytsarev · 2021-03-03T10:01:07Z

.github/workflows/helm_publish.yaml

+  publish:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v1


Please switch to v2

k0da · 2021-03-03T10:05:08Z

so I tested pull-request action here https://github.com/k0da/terraform-controller/runs/2020895388?check_suite_focus=true
results into k0da/terraform-controller#3

k0da · 2021-03-03T10:06:15Z

IMO any way automated PR can be closed any time. So this is quite harmless improvement

ytsarev

lgtm

somaritane

lgtm, can't wait for new release :)🤞

* Adds separate Dockerfile for each architecture to keep base image unchanged. * Brings github_changelog_generator into a release pipeline * Add .goreleaser.yaml with go build and amd64/arm64 images with docker common manifest * Introduce pipeline for tag event, where docker artifacts will be built. * Rename helm pipeline (release) into helm_publish * Opens pull-request with offline changelog (CHANGELOG.md) update Signed-off-by: Dinar Valeev <dinar.valeev@absa.africa>

k0da · 2021-03-03T12:14:05Z

@somaritane @ytsarev I've ammended fetch-depth param to checkout action to preserve full history for github_changelog_generator

k0da requested review from donovanmuller, kuritka, somaritane and ytsarev as code owners March 1, 2021 13:57

ytsarev reviewed Mar 1, 2021

View reviewed changes

k0da force-pushed the releaser branch from f066636 to 5119159 Compare March 1, 2021 15:35

ytsarev reviewed Mar 1, 2021

View reviewed changes

k0da force-pushed the releaser branch 2 times, most recently from d65ae3a to 7d519e9 Compare March 2, 2021 09:19

ytsarev previously approved these changes Mar 2, 2021

View reviewed changes

somaritane previously approved these changes Mar 2, 2021

View reviewed changes

k0da dismissed stale reviews from somaritane and ytsarev via 76b2d61 March 2, 2021 12:17

k0da force-pushed the releaser branch from 7d519e9 to 76b2d61 Compare March 2, 2021 12:17

k0da requested review from somaritane and ytsarev March 2, 2021 13:03

k0da force-pushed the releaser branch from 76b2d61 to b0813d7 Compare March 2, 2021 14:18

ytsarev reviewed Mar 2, 2021

View reviewed changes

k0da force-pushed the releaser branch 2 times, most recently from 037ec14 to 88641c8 Compare March 2, 2021 19:56

ytsarev requested changes Mar 3, 2021

View reviewed changes

k0da force-pushed the releaser branch from 88641c8 to 1e618a1 Compare March 3, 2021 10:03

k0da requested a review from ytsarev March 3, 2021 10:06

ytsarev previously approved these changes Mar 3, 2021

View reviewed changes

somaritane previously approved these changes Mar 3, 2021

View reviewed changes

k0da dismissed stale reviews from somaritane and ytsarev via c90ee9d March 3, 2021 12:11

k0da force-pushed the releaser branch from 1e618a1 to c90ee9d Compare March 3, 2021 12:11

k0da requested review from somaritane and ytsarev March 3, 2021 12:13

ytsarev approved these changes Mar 3, 2021

View reviewed changes

somaritane approved these changes Mar 3, 2021

View reviewed changes

k0da merged commit e0a4333 into master Mar 3, 2021

somaritane deleted the releaser branch March 9, 2021 20:49

Automate releases #334

Automate releases #334

Conversation

k0da commented Mar 1, 2021 • edited Loading

ytsarev commented Mar 1, 2021 • edited Loading

ytsarev left a 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

Choose a reason for hiding this comment

k0da Mar 1, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

somaritane commented Mar 1, 2021

ytsarev commented Mar 1, 2021

k0da commented Mar 1, 2021

If set to true, will not auto-publish the release.

Default is false.

draft: false

somaritane commented Mar 1, 2021 • edited Loading

k0da commented Mar 1, 2021

ytsarev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k0da commented Mar 2, 2021

ytsarev left a comment

Choose a reason for hiding this comment

somaritane left a 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

ytsarev Mar 2, 2021 • 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

k0da commented Mar 3, 2021

k0da commented Mar 3, 2021

ytsarev left a comment

Choose a reason for hiding this comment

somaritane left a comment

Choose a reason for hiding this comment

k0da commented Mar 3, 2021

k0da commented Mar 1, 2021 •

edited

Loading

ytsarev commented Mar 1, 2021 •

edited

Loading

k0da Mar 1, 2021 •

edited

Loading

somaritane commented Mar 1, 2021 •

edited

Loading

ytsarev Mar 2, 2021 •

edited

Loading