update the github action for release notes to use the release note labels to automate release note generation #613

gabemontero · 2021-02-22T17:45:56Z

Changes

The first stage in automating release notes.

As I indicated in the mailing list and slack, if we force use of the kind label in our PRs, I can make a subsequent PR to this that will sort release notes by kind

This borrows from upstream tekton, but translates from being encapsulated by github actions to tekton tasks, as well as makes a few other simplifications given the "simpler nature" of our project.

/assign @adambkaplan
/assign @qu1queee

Submitter Checklist

[n/a ] Includes tests if functionality changed/was added
[n/a ] Includes docs if changes are user-facing
[y ] Release notes block has been filled in, or marked NONE

See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.

Release Notes

NONE

gabemontero · 2021-02-22T19:12:09Z

An example of the release notes I get in Changes.md when I run HEAD against the v0.3.0 tag:

#595 by qu1queee: Restructure BuildRun reconcile code into separate classes.
#593 by qu1queee: Move controller/reconcile logic into reconciler pkg
#592 by HeavyWombat: Fixed an issue where the build-controller fails to Reconcile with a panic due to a nil pointer dereference. The issue can arise in case there is a failed TaskRun with a pod that has still running (unfinished) containers.

gabemontero · 2021-02-23T13:54:46Z

I believe this PR's test runs will benefit from @SaschaSchwarze0 's #614

adambkaplan · 2021-02-23T14:13:22Z

.github/workflows/release.yaml

+          PR_NUM=$(echo $pr | cut -d';' -f3)
+          PR_RELEASE_NOTE=$(wget -q -O- https://api.github.com/repos/shipwright-io/build/issues/${PR_NUM:1} | jq .body -r | grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)' | grep -avP '\W*(Your release note here|action required: your release note here|NONE)\W*')
+          echo -e "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE" >> Changes.md
+        done < last-300-prs-with-release-note.txt


Can we move this to a bash script that we keep in-tree - example under /hack?

Presumably ... just to be clear, what is motivating your ask here?

Doing some research on how to do it, it seems perhaps that putting the shell script in the .github folder or .github/actions folder might be more "approved" or "best practice".

From some github dev forums:

https://gh.neting.ccmunity/t/running-a-bash-script/141584

https://github.com/actions/github-script

+1 on externalizing this into a script.

ok @adambkaplan @qu1queee I've moved the logic to a script file, following the github actions guidance from https://gh.neting.ccmunity/t/running-a-bash-script/141584

gabemontero · 2021-02-24T13:56:24Z

/refresh

gabemontero · 2021-02-24T13:57:12Z

let's see if I have to close/reopen this to refresh the e2e list after #614 merged

gabemontero · 2021-02-24T13:57:39Z

/retest

gabemontero · 2021-02-24T13:58:20Z

/skip

gabemontero · 2021-02-24T14:32:29Z

/close

openshift-ci-robot · 2021-02-24T14:32:30Z

@gabemontero: Closed this PR.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

gabemontero · 2021-02-24T14:32:42Z

/reopen

openshift-ci-robot · 2021-02-24T14:32:44Z

@gabemontero: Reopened this PR.

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

gabemontero · 2021-02-24T14:43:11Z

yep closing / reopening was needed to clear out the new defunct tests

gabemontero · 2021-02-24T17:14:33Z

ok all green e2e's ... thanks @SaschaSchwarze0

now circling back to pulling new changes into a separate shell script

@adambkaplan @qu1queee my first thought is to update the new script to deal with PR kind labels in a separate PR, once the use of the prow plugin has merged and there a couple of PRs with both release notes and kind labels to test with

gabemontero · 2021-02-24T18:08:46Z

ok @adambkaplan @qu1queee e2e's are green and new logic broken out into a script file

let the opinions on how to write bash commence :-)

gabemontero · 2021-02-25T00:56:16Z

/approve

openshift-ci-robot · 2021-02-25T00:56:20Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gabemontero

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [gabemontero]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

adambkaplan

final nits

adambkaplan · 2021-02-25T19:58:02Z

.github/draft_release_notes.sh

@@ -0,0 +1,52 @@
+# this script assumes the GITHUB_TOKEN and PREVIOUS_TAG environment variables have been set;


Needs a shebang?

Suggested change

# this script assumes the GITHUB_TOKEN and PREVIOUS_TAG environment variables have been set;

#! /bin/sh

# this script assumes the GITHUB_TOKEN and PREVIOUS_TAG environment variables have been set;

updated / squashed / pushed @adambkaplan

adambkaplan · 2021-02-25T19:59:56Z

.github/workflows/release.yaml

-        git log --pretty=format:"%h -  %s - %an" ${{ github.event.inputs.tags }}..HEAD | grep -v "Merge pull" >> Changes.md
-        echo -e "## Features\n\n## Fixes\n\n## Backwards incompatible changes\n\n## Docs\n\n## Misc\n\n## Thanks" >> Changes.md    - name: Draft Release
+        # might not be necessary but make sure
+        chmod +x "${GITHUB_WORKSPACE}/.github/draft_release_notes.sh"


You may want to ensure that the checked-in bash script has +x permissions. I believe git preserves those.

gmontero ~/go/src/github.com/shipwright-io/build (release-note-2)$ ls -la .github/draft_release_notes.sh -rwxrwxr-x. 1 gmontero gmontero 3127 Feb 24 12:36 .github/draft_release_notes.sh gmontero ~/go/src/github.com/shipwright-io/build (release-note-2)$

gabemontero · 2021-02-25T21:00:37Z

updates pushed @adambkaplan

I'll update the PR on whether tests are green if you are waiting on that for lgtm

qu1queee · 2021-02-26T09:10:11Z

@gabemontero let me check this today, not sure why you approve your own pr, I find this strange.

EDIT: I delegated this to Matthias.

HeavyWombat

Thanks for the release notes automation. This is awesome. I am looking forward to it. Pretty sure this is help enormously. I ran shellcheck against the file and highlighted some of the issues. Nothing blocking, I think. The only thing I would like to look into is the seemingly trailing extra text.

.github/draft_release_notes.sh

.github/workflows/release.yaml

gabemontero · 2021-03-01T19:47:37Z

pushed an update with the changes @HeavyWombat recommended - thanks !!

explanations in the comment threads for changes that were not pulled in

…bels to automate release note generation

imjasonh · 2021-03-05T15:14:49Z

/lgtm

openshift-ci-robot assigned adambkaplan and qu1queee Feb 22, 2021

openshift-ci-robot added the release-note-none Label for when a PR does not need a release note label Feb 22, 2021

openshift-ci-robot requested review from qu1queee and sbose78 February 22, 2021 17:45

gabemontero added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Feb 22, 2021

gabemontero force-pushed the release-note-2 branch from d832378 to 4cb6265 Compare February 22, 2021 19:06

gabemontero force-pushed the release-note-2 branch from 4cb6265 to e52cd4f Compare February 23, 2021 13:40

adambkaplan requested changes Feb 23, 2021

View reviewed changes

openshift-ci-robot closed this Feb 24, 2021

openshift-ci-robot reopened this Feb 24, 2021

gabemontero force-pushed the release-note-2 branch from e52cd4f to 3b099b2 Compare February 24, 2021 17:37

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 25, 2021

adambkaplan requested changes Feb 25, 2021

View reviewed changes

gabemontero force-pushed the release-note-2 branch from 3b099b2 to d7409dd Compare February 25, 2021 20:57

HeavyWombat requested changes Feb 26, 2021

View reviewed changes

qu1queee removed their request for review February 26, 2021 14:43

gabemontero mentioned this pull request Mar 1, 2021

Enhance CI for shipping releases #574

Closed

gabemontero force-pushed the release-note-2 branch from d7409dd to 34705d1 Compare March 1, 2021 19:46

update the github action for release notes to use the release note la…

fe5916c

…bels to automate release note generation

gabemontero force-pushed the release-note-2 branch from 34705d1 to fe5916c Compare March 1, 2021 20:29

qu1queee requested review from qu1queee and removed request for qu1queee March 2, 2021 20:17

qu1queee removed their assignment Mar 2, 2021

qu1queee requested review from qu1queee and adambkaplan and removed request for qu1queee March 2, 2021 20:17

HeavyWombat approved these changes Mar 3, 2021

View reviewed changes

openshift-ci-robot assigned imjasonh Mar 5, 2021

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 5, 2021

openshift-merge-robot merged commit fd67f6a into shipwright-io:master Mar 5, 2021

gabemontero deleted the release-note-2 branch March 5, 2021 16:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update the github action for release notes to use the release note labels to automate release note generation #613

update the github action for release notes to use the release note labels to automate release note generation #613

gabemontero commented Feb 22, 2021 •

edited

Loading

gabemontero commented Feb 22, 2021

gabemontero commented Feb 23, 2021

adambkaplan Feb 23, 2021

gabemontero Feb 23, 2021

gabemontero Feb 23, 2021

qu1queee Feb 24, 2021

gabemontero Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

openshift-ci-robot commented Feb 24, 2021

gabemontero commented Feb 24, 2021

openshift-ci-robot commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 25, 2021

openshift-ci-robot commented Feb 25, 2021

adambkaplan left a comment

adambkaplan Feb 25, 2021

gabemontero Feb 25, 2021

adambkaplan Feb 25, 2021

gabemontero Feb 25, 2021

gabemontero commented Feb 25, 2021

qu1queee commented Feb 26, 2021 •

edited

Loading

HeavyWombat left a comment

gabemontero commented Mar 1, 2021

imjasonh commented Mar 5, 2021

		@@ -0,0 +1,52 @@
		# this script assumes the GITHUB_TOKEN and PREVIOUS_TAG environment variables have been set;

update the github action for release notes to use the release note labels to automate release note generation #613

update the github action for release notes to use the release note labels to automate release note generation #613

Conversation

gabemontero commented Feb 22, 2021 • edited Loading

Changes

Submitter Checklist

Release Notes

gabemontero commented Feb 22, 2021

gabemontero commented Feb 23, 2021

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

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

openshift-ci-robot commented Feb 24, 2021

gabemontero commented Feb 24, 2021

openshift-ci-robot commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 24, 2021

gabemontero commented Feb 25, 2021

openshift-ci-robot commented Feb 25, 2021

adambkaplan 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

gabemontero commented Feb 25, 2021

qu1queee commented Feb 26, 2021 • edited Loading

HeavyWombat left a comment

Choose a reason for hiding this comment

gabemontero commented Mar 1, 2021

imjasonh commented Mar 5, 2021

gabemontero commented Feb 22, 2021 •

edited

Loading

qu1queee commented Feb 26, 2021 •

edited

Loading