From f56e1430cdd31ed21e96575d3fba05a7a1369191 Mon Sep 17 00:00:00 2001
From: Nicolas Mattia <nicolas@dfinity.org>
Date: Tue, 29 Mar 2022 16:10:34 +0200
Subject: [PATCH] Generate custom release notes (#608)

This makes sure we generate our own release notes. Using automated
release notes is a bit flaky because GitHub uses some heuristics to
figure out what the latest release is, which is not very reliable.
---
 .github/actions/release/action.yml   |  4 ++++
 .github/actions/release/run          | 27 +++++++++++++++++++++++++++
 .github/workflows/canister-tests.yml |  5 ++---
 3 files changed, 33 insertions(+), 3 deletions(-)

diff --git a/.github/actions/release/action.yml b/.github/actions/release/action.yml
index d5264c5052..7b5d23a001 100644
--- a/.github/actions/release/action.yml
+++ b/.github/actions/release/action.yml
@@ -5,6 +5,10 @@ inputs:
         description: "Assets to upload"
         required: true
         default: ""
+    token:
+        description: "GitHub authentication token"
+        required: true
+        default: ""
 outputs:
   notes-file:
     description: The notes file
diff --git a/.github/actions/release/run b/.github/actions/release/run
index 23be7ecb69..94b348cdd2 100755
--- a/.github/actions/release/run
+++ b/.github/actions/release/run
@@ -90,6 +90,33 @@ do
     shasum -a 256 "$filename"  | sed -r "s%^([a-z0-9]+)[[:space:]][[:space:]](.*)$%|$download|$sha|$run|%" >> "$body"
 done <<< "$INPUT_ASSETS"
 
+>&2 echo "Creating release notes"
+
+# NOTE: we create the release notes ourselves, instead of letting GitHub do it with
+# 'generate_release_notes: true', here we can actually specify the release range. When doing
+# it on its own, GitHub is really bad at figuring which tag to use as the previous tag (for
+# listing contributions since).
+# https://github.com/github/feedback/discussions/5975
+
+previous_tag_name=$(curl \
+    -H "Accept: application/vnd.github.v3+json" \
+    https://api.github.com/repos/dfinity/internet-identity/releases \
+    | jq -cMr 'sort_by(.published_at) | reverse | .[0] | .tag_name')
+>&2 echo "Using following tag as previous: $previous_tag_name"
+
+jq_body=$(jq -cM -n \
+    --arg previous_tag_name "$previous_tag_name" \
+    --arg tag_name "$GITHUB_REF_NAME" \
+    '{ tag_name: $tag_name, previous_tag_name: $previous_tag_name }')
+
+curl \
+    -X POST \
+    -H "authorization: token ${INPUT_TOKEN:?No token given}" \
+    -H "Accept: application/vnd.github.v3+json" \
+    https://api.github.com/repos/dfinity/internet-identity/releases/generate-notes \
+    --data "$jq_body" \
+    | jq -cMr '.body' >> "$body"
+
 >&2 echo "body complete:"
 
 cat "$body"
diff --git a/.github/workflows/canister-tests.yml b/.github/workflows/canister-tests.yml
index 4e86462228..4314dc86fb 100644
--- a/.github/workflows/canister-tests.yml
+++ b/.github/workflows/canister-tests.yml
@@ -365,7 +365,7 @@ jobs:
   # This ... releases
   release:
     runs-on: ubuntu-latest
-
+    if: startsWith(github.ref, 'refs/tags/release-')
     needs: docker-build
 
     steps:
@@ -397,14 +397,13 @@ jobs:
             internet_identity_test.wasm
             internet_identity_dev.wasm
             internet_identity_production.wasm
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish release
-        if: startsWith(github.ref, 'refs/tags/release-')
         run: |
           ./scripts/release \
             --tag ${{ github.ref }} \
             --notes-file ${{ steps.prepare-release.outputs.notes-file }} \
-            --generate-notes \
             -- \
             internet_identity_test.wasm \
             internet_identity_dev.wasm \