Merge pull request #712 from gabemontero/rel-note-script-fix

validate PR release-note text, skip entries with invalid format; various sh/bash differences between fedora and ubuntu; add sorting based on kind labels

.github/draft_release_notes.sh

@@ -1,4 +1,4 @@
-#! /bin/sh
+#! /bin/bash
 # Copyright The Shipwright Contributors
 #
 # SPDX-License-Identifier: Apache-2.0
@@ -16,15 +16,26 @@ if [ -z ${PREVIOUS_TAG+x} ]; then
 fi
 
 sudo apt-get -y update
-sudo apt-get -y install jq wget
+sudo apt-get -y install wget curl git
 curl -L https://github.com/github/hub/releases/download/v2.14.2/hub-linux-amd64-2.14.2.tgz | tar xzf -
 PWD="$(pwd)"
 export PATH=$PWD/hub-linux-amd64-2.14.2/bin:$PATH
 git fetch --all --tags --prune --force
-echo -e "# Insert Title\n" > 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
+echo "# Draft Release changes since ${PREVIOUS_TAG}" > Changes.md
+echo > Features.md
+echo "## Features" >> Features.md
+echo > Fixes.md
+echo "## Fixes" >> Fixes.md
+echo > API.md
+echo "## API Changes" >> API.md
+echo > Docs.md
+echo "## Docs" >> Docs.md
+echo > Misc.md
+echo "## Misc" >> Misc.md
+
 # this effectively gets the commit associated with github.event.inputs.tags
 COMMON_ANCESTOR=$(git merge-base $PREVIOUS_TAG HEAD)
+echo "COMMON_ANCESTOR is ${COMMON_ANCESTOR}"
 # in theory the new tag has not been created yet; do we want another input that specifies the existing
 # commit desired for drafting the release? for now, we are using HEAD in the above git merge-base call
 # and PR cross referencing below
@@ -35,16 +46,21 @@ COMMON_ANCESTOR=$(git merge-base $PREVIOUS_TAG HEAD)
 # NOTE: investigated using the new 'gh' cli command, but its 'gh pr list' does not currently support the -f option so
 # staying with 'hub' for now.
 hub pr list --state merged -L 300 -f "%sm;%au;%i;%t;%L%n" | grep -E ", release-note|release-note," | grep -v release-note-none | grep -v release-note-action-required > last-300-prs-with-release-note.txt
+# this is for debug while we sort out env differences between Gabe's fedora and GitHub Actions' ubuntu
+echo "start dump last-300-prs-with-release-note.txt for potential debug"
+cat last-300-prs-with-release-note.txt
+echo "end dump last-300-prs-with-release-note.txt for potential debug"
 # now we cylce through last-300-prs-with-release-note.txt, filtering out stuff that is too old or other anomalies,
 # and update Changes.md with the release note.
 while IFS= read -r pr; do
    SHA=$(echo $pr | cut -d';' -f1)
+
    # skip the common ancestor, which in essences is the commit associated with the tag github.event.inputs.tags
    if [ "$SHA" == "$COMMON_ANCESTOR" ]; then
       continue
    fi
 
-   # styllistic clarification, purposefully avoiding slicker / cleverer / more compact scripting conventions
+   # stylistic clarification, purposefully avoiding slicker / cleverer / more compact scripting conventions
 
    # this makes sure that this PR has merged
    git merge-base --is-ancestor $SHA HEAD
@@ -61,6 +77,65 @@ while IFS= read -r pr; do
    # if we are at this point, we have a PR with a release note to add
    AUTHOR=$(echo $pr | cut -d';' -f2)
    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
+   echo "Examining from ${AUTHOR} PR ${PR_NUM}"
+   PR_BODY=$(wget -q -O- https://api.github.com/repos/shipwright-io/build/issues/${PR_NUM:1})
+   echo $PR_BODY | grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)' > /dev/null 2>&1
+   rc=$?
+   if [ ${rc} -eq 1 ]; then
+      echo "First validation:  the release-note field for PR ${PR_NUM} was not properly formatted.  Until it is fixed, it will be skipped for release note inclusion."
+      echo "See the PR template at https://raw.githubusercontent.com/shipwright-io/build/master/.github/pull_request_template.md for verification steps"
+      continue
+   fi
+   PR_BODY_FILTER_ONE=$(echo $PR_BODY | grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)')
+   echo $PR_BODY_FILTER_ONE | grep -avP '\W*(Your release note here|action required: your release note here|NONE)\W*' > /dev/null 2>&1
+   rc=$?
+   if [ ${rc} -eq 1 ]; then
+      echo "Second validation:  the release-note field for PR ${PR_NUM} was not properly formatted.  Until it is fixed, it will be skipped for release note inclusion."
+      echo "See the PR template at https://raw.githubusercontent.com/shipwright-io/build/master/.github/pull_request_template.md for verification steps"
+      continue
+   fi
+   PR_RELEASE_NOTE=$(echo $PR_BODY_FILTER_ONE | grep -avP '\W*(Your release note here|action required: your release note here|NONE)\W*')
+   PR_RELEASE_NOTE_NO_NEWLINES=$(echo $PR_RELEASE_NOTE | sed 's/\\n//g' | sed 's/\\r//g')
+   MISC=yes
+   echo $pr | grep 'kind/bug'
+   rc=$?
+   if [ ${rc} -eq 0 ]; then
+      echo >> Fixes.md
+      echo "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE_NO_NEWLINES" >> Fixes.md
+      MISC=no
+   fi
+   echo $pr | grep 'kind/api-change'
+   rc=$?
+   if [ ${rc} -eq 0 ]; then
+      echo >> API.md
+      echo "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE_NO_NEWLINES" >> API.md
+      MISC=no
+   fi
+   echo $pr | grep 'kind/feature'
+   rc=$?
+   if [ ${rc} -eq 0 ]; then
+      echo >> Features.md
+      echo "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE_NO_NEWLINES" >> Features.md
+      MISC=no
+   fi
+   echo $pr | grep 'kind/documentation'
+   rc=$?
+   if [ ${rc} -eq 0 ]; then
+      echo >> Docs.md
+      echo "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE_NO_NEWLINES" >> Docs.md
+      MISC=no
+   fi
+   if [ "$MISC" == "yes" ]; then
+      echo >> Misc.md
+      echo "$PR_NUM by $AUTHOR: $PR_RELEASE_NOTE_NO_NEWLINES" >> Misc.md
+   fi
+   # update the PR template if our greps etc. for pulling the release note changes
+   #PR_RELEASE_NOTE=$(wget -q -O- https://api.github.com/repos/shipwright-io/build/issues/${PR_NUM:1} | grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)' | grep -avP '\W*(Your release note here|action required: your release note here|NONE)\W*')
+   echo "Added from ${AUTHOR} PR ${PR_NUM:1} to the release note draft"
 done < last-300-prs-with-release-note.txt
+
+cat Features.md >> Changes.md
+cat Fixes.md >> Changes.md
+cat API.md >> Changes.md
+cat Docs.md >> Changes.md
+cat Misc.md >> Changes.md

.github/pull_request_template.md

@@ -49,4 +49,14 @@ For pull requests that don't need to be mentioned at release time, use the `/rel
 ```release-note
 NONE
 ```
+
+Note, your release note has to meet the formatting restrictions noted above precisely, or else it will not be included.
+To validate its inclusion, run:
+
+```
+# export PR_NUM=<your PR number>
+wget -q -O- https://api.github.com/repos/shipwright-io/build/issues/${PR_NUM} | grep -oPz '(?s)(?<=```release-note..)(.+?)(?=```)' | grep -avP '\W*(Your release note here|action required: your release note here|NONE)\W*'
+```
+
+If you do not see your release note text in the output, your formatting did not conform to the examples above.
 -->