Add reusable workflows for release #63

friedrichwilken · 2024-01-30T16:03:10Z

Description

Changes proposed in this pull request:

add reusable workflow that gets version from branch
add reusable workflow that renders and uploads manifests
add reusable workflow that creates a draft release
add reusable workflow that publishes a draft release
add reusable workflow that triggers and awaits prow jobs
improve the bump-sec-scanners-config-reusable.yml workflow

Related issue(s)
kyma-project/eventing-manager#361

muralov · 2024-01-31T14:48:01Z

.github/workflows/bump-sec-scanners-config-reusable.yml

@@ -157,11 +156,11 @@ jobs:
        run: |
          echo "please review  ${PR_URL}"

-      - name: Wait for PR to be Merged
        if: ${{ env.CREATE_PR == 'true' }}


Have you tested this line if it worked as before? I think, it doesn't work as if is outside the job.

I do not touch this line in this PR.

But yes, in the PR that created this, I mention:

tested by creating a carbon copy of it here and using it here. The workflow was triggered here, resulting in this PR. After merging the PR, the started workflow finished successfully.

echo "PR_URL=${PR_URL}" >> $GITHUB_ENV
is like defining a env var in the job; it will become available in all the steps.

muralov · 2024-01-31T14:50:22Z

.github/workflows/bump-sec-scanners-config-reusable.yml

          git config user.name "${ghusername}"
          # set git mail address
-          ghmailaddress=$(curl -H "Authorization: token ${GH_TOKEN}" https://api.github.com/email)
+          ghmailaddress="${ghusername}@users.noreply.github.com"


why do you want no reply email thing?

because the kyma-eventing-bot will not answer emails.

muralov · 2024-01-31T15:21:41Z

.github/workflows/publish-release-reusable.yml

+          GH_TOKEN: ${{ secrets.BOT_PAT }}
+        shell: bash
+        run: |
+          gh release edit "${VERSION}" --draft=false --latest


you have --latest flag because if set the latest release is edited. We want to edit the VERSION. Should we delete the latest flag?

I have set the --latest flag because it will mark the release -identified as VERSION- as latest.

--latest Explicitly mark the release as "Latest"

In this step we edit the draft release and turn it into a real release. We also set it to be the latest release.
I think we should leave this flag.

muralov · 2024-01-31T15:35:01Z

.github/workflows/trigger-prow-build-job-reusable.yml

+        required: true
+        type: string
+        description: The semantic version number.
+      TIMEOUT:


I see TIMEOUT is not used anywhere.

muralov · 2024-01-31T15:35:20Z

.github/workflows/trigger-prow-build-job-reusable.yml

+      TIMEOUT:
+        type: number
+        default: 60000 # 10 minutes in miliseconds
+      INTERVAL:


I see INTERVAL is not used anywhere.

marcobebway · 2024-02-01T08:12:58Z

.github/workflows/bump-sec-scanners-config-reusable.yml

 #         version_tag: 2.3.4
-#         timeout: 3600 # 1 hour
+#         TIMEOUT: 3600 # 1 hour


Lowercase or Uppercase version_tag and TIMEOUT, please keep this consistent.

marcobebway · 2024-02-01T08:17:14Z

.github/workflows/bump-sec-scanners-config-reusable.yml

@@ -87,29 +84,30 @@ jobs:
            echo "CREATE_PR=true" >> $GITHUB_ENV 
          fi

-      - name: Print Content of sec-scanners-config.yaml
        if: ${{ always() }}


Why do we need if always? Can we remove it?

always() will make sure this will get executed even if an earlier step fails. This is particularly useful for debugging say in case you want to know if at least rendering the file went all right.

always() will ensure this will get executed even if an earlier step fails. This is particularly useful for debugging say in case you want to know if at least rendering the file went all right.

marcobebway · 2024-02-01T08:24:52Z

.github/workflows/bump-sec-scanners-config-reusable.yml

        shell: bash
        run: |
          # set git username 
-          ghusername=$(curl -H "Authorization: token ${GH_TOKEN}" https://api.github.com/user)
+          ghusername=$(curl -s -H "Authorization: token ${GH_TOKEN}" https://api.github.com/user | jq '.login')


Is there a step to install jq or is it available out of the box?

jq is available on the ubuntu-latest image used by GitHub.

marcobebway · 2024-02-01T08:29:50Z

.github/workflows/create-draft-release-reusable.yml

+        type: string
+        description: The semantic version number.
+    secrets:
+      BOT_PAT:


(nit) for readability, does it make sense to rename BOT_PAT to BOT_TOKEN?

Mhh, I am indifferent to the wording. My argument for PAT is that the personal access token is a special kind of token. But BOT_TOKEN would be fine for me too.

What do you say?

It is a nitpick, let's keep the pat!

marcobebway · 2024-02-01T08:32:02Z

.github/workflows/bump-sec-scanners-config-reusable.yml

        uses: actions/checkout@v4

      - name: Render sec-scanners-config.yaml
        env:
-          VERSION_TAG: ${{ inputs.version_tag }}
-        shell: bash


Why shell: bash is removed?

that was a mishap and I will revert it.

marcobebway · 2024-02-01T08:37:03Z

.github/workflows/create-draft-release-reusable.yml

+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        shell: bash
+        run: |
+          # Note: your repository needs to have this script.


If this script does not exist, will there be an error message indicating that?

marcobebway · 2024-02-01T08:38:27Z

.github/workflows/create-draft-release-reusable.yml

+          ./hack/scripts/create_changelog.sh "${VERSION}"
+
+      - name: Print out changelog
+        run: cat CHANGELOG.md


If there are no changes, what will be printed?

That depends on the script. With what we have it will be only headlines and a link to the full changelogs.

Does it make sense here to print a message before and after the cat indicating the beginning and end of the change log?

That's the reason why I placed this in its own step. I makes it easy to find and easy to read. It will look like this

|> Run cat CHANGELOG.md Changelog blah blah blah Changelog blah Changelog blah-blah

So to answer the question, no, I think it is good already.

marcobebway · 2024-02-01T08:46:52Z

.github/workflows/get-version-from-release-branch-reusable.yml

+    outputs:
+      VERSION:
+        description: "The semantic version x.y.z, e.g.: 1.7.4"
+        value: ${{ jobs.create-version.outputs.VERSION }}


Is the name create-version under our control? If yes, please rename it to create_version to be consistent with similar names in other places like ${{ github.repository_owner }}.

In github actions it is customary practice to name jobs and step IDs with a dash.

my-job: steps: - name: "my step" id: my-step

while env vars and secrets spelled most of the time with an underscore e.g. MY_VAR and MY_SECRET

marcobebway · 2024-02-01T08:59:35Z

.github/workflows/get-version-from-release-branch-reusable.yml

+        run: |
+          CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
+          [[ $CURRENT_BRANCH =~ ^release-([0-9]+)\.([0-9]+)$ ]] || exit 1
+          echo "MAJOR=${BASH_REMATCH[1]}" >> $GITHUB_ENV


What is the value of BASH_REMATCH? Which part sets that value?

$BASH_REMATCH is an array and contains the matches of a regular expression.
doc
A very handy little tool.

marcobebway · 2024-02-01T09:12:26Z

.github/workflows/render-and-upload-manifests-reusbale.yml

@@ -0,0 +1,60 @@
+name: Render and upload manifests (reusable)


The filename is misspelled:
render-and-upload-manifests-reusbale.yml -> render-and-upload-manifests-reusable.yml

thanks! Resolved.

marcobebway · 2024-02-01T09:40:29Z

.github/workflows/trigger-prow-build-job-reusable.yml

+          # set git mail address
+          ghmailaddress="${ghusername}@users.noreply.github.com"


(nit) mail -> email

Reasonable. I changed it.

friedrichwilken added 2 commits January 30, 2024 16:58

add reusable workflows for release

1662375

improve bum-sec-scanners-config

c282ca3

friedrichwilken requested a review from a team as a code owner January 30, 2024 16:03

friedrichwilken requested a review from muralov January 30, 2024 16:03

kyma-bot added area/ci Issues or PRs related to CI related topics cla: yes Indicates the PR's author has signed the CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 30, 2024

friedrichwilken added 2 commits January 30, 2024 17:12

add comments

c7ea6f1

add workflow to trigger prow jobs

919c26c

friedrichwilken linked an issue Jan 31, 2024 that may be closed by this pull request

auto-bump images in Create release workflow kyma-project/eventing-manager#361

Closed

3 tasks

muralov reviewed Jan 31, 2024

View reviewed changes

marcobebway reviewed Feb 1, 2024

View reviewed changes

friedrichwilken added 2 commits February 1, 2024 09:26

pass timeout and interval

8f5f06d

pass github token

36a39b2

marcobebway reviewed Feb 1, 2024

View reviewed changes

updated comments

585a5b1

marcobebway reviewed Feb 1, 2024

View reviewed changes

revert removed shell instructions

6acdf78

marcobebway reviewed Feb 1, 2024

View reviewed changes

rename file

f666d7c

marcobebway reviewed Feb 1, 2024

View reviewed changes

change spelling

9f7d513

friedrichwilken changed the title ~~Add resuable workflows for release~~ Add reusable workflows for release Feb 1, 2024

friedrichwilken added 2 commits February 1, 2024 14:05

remove CRD_FILE

49029ad

add yq

867277f

marcobebway approved these changes Feb 1, 2024

View reviewed changes

kyma-bot assigned marcobebway Feb 1, 2024

kyma-bot added the lgtm Looks good to me! label Feb 1, 2024

kyma-bot merged commit d491378 into kyma-project:main Feb 1, 2024
5 checks passed

friedrichwilken removed a link to an issue Feb 8, 2024

auto-bump images in Create release workflow kyma-project/eventing-manager#361

Closed

3 tasks

		@@ -0,0 +1,60 @@
		name: Render and upload manifests (reusable)

		# set git mail address
		ghmailaddress="${ghusername}@users.noreply.github.com"

Add reusable workflows for release #63

Add reusable workflows for release #63

Conversation

friedrichwilken commented Jan 30, 2024 • edited Loading

Choose a reason for hiding this comment

friedrichwilken Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

muralov Jan 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcobebway Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • 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

marcobebway Feb 1, 2024 • 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

marcobebway Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

marcobebway Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedrichwilken Feb 1, 2024 • 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

friedrichwilken Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

friedrichwilken commented Jan 30, 2024 •

edited

Loading

friedrichwilken Jan 31, 2024 •

edited

Loading

friedrichwilken Jan 31, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

muralov Jan 31, 2024 •

edited

Loading

marcobebway Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

marcobebway Feb 1, 2024 •

edited

Loading

marcobebway Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

marcobebway Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading

friedrichwilken Feb 1, 2024 •

edited

Loading