Automatically close release issue and add comments to workflow files

Author: thomaseizinger

.github/workflows/draft-new-release.yml

@@ -27,20 +27,26 @@ jobs:
         with:
           version: ${{ env.RELEASE_VERSION }}
 
+      # In order to make a commit, we need to initialize a user.
+      # You may choose to write something less generic here if you want, it doesn't matter functionality wise.
       - name: Initialize mandatory git config
         run: |
           git config user.name "GitHub actions"
           git config user.email noreply@github.com
 
       # This step will differ depending on your project setup
+      # Fortunately, yarn has a built-in command for doing this!
       - name: Bump version in package.json
         run: yarn version --new-version ${{ env.RELEASE_VERSION }} --no-git-tag-version
 
       - name: Commit changelog and manifest files
+        id: make-commit
         run: |
           git add CHANGELOG.md package.json
           git commit --message "Prepare release ${{ env.RELEASE_VERSION }}"
 
+          echo "::set-output name=commit::$(git rev-parse HEAD)"
+
       - name: Push new branch
         run: git push origin release/${{ env.RELEASE_VERSION }}
 
@@ -51,6 +57,14 @@ jobs:
           head: release/${{ env.RELEASE_VERSION }}
           base: master
           title: ${{ github.event.issue.title }}
-          reviewers: ${{ github.event.issue.user.login }}
+          reviewers: ${{ github.event.issue.user.login }} # By default, we request a review from the person who opened the issue. You can replace this with a static list of users.
+          # Write a nice message to the user.
+          # We are claiming things here based on the `publish-new-release.yml` workflow.
+          # You should obviously adopt it to say the truth depending on your release workflow :)
           body: |
-            Resolves #${{ github.event.issue.number }}
+            Hi ${{ github.event.issue.user.login }}!
+
+            This PR was created in response to this release issue: #${{ github.event.issue.number }}.
+            I've updated the changelog and bumped the versions in the manifest files in this commit: ${{ steps.make-commit.outputs.commit }}.
+
+            Merging this PR will create a GitHub release and upload any assets that are created as part of the release build.

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

@@ -29,6 +29,22 @@ jobs:
 
           echo "::set-env name=RELEASE_VERSION::$VERSION"
 
+      # Unfortunately, GitHub doesn't trigger events for actions that have been taken by a GitHub action.
+      # This means we cannot use `Fixes #issue_number.` in the body of the PR to close the release issue after the branch is merged.
+      # Hence, we close it here "manually"
+      - name: Close release issue
+        run: |
+
+          RELEASE_ISSUE_URL=$(curl https://api.github.com/repos/${{ github.repository }}/issues?labels=release&state=open | jq -r '.[1].url')
+
+          curl \
+            -X PATCH \
+            -H 'Accept: application/vnd.github.v3+json' \
+            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            -H "Content-Type: application/json" \
+            $RELEASE_ISSUE_URL \
+            -d '{"state":"closed"}'
+
       - name: Create Release
         uses: thomaseizinger/create-release@1.0.0
         env:
@@ -52,3 +68,4 @@ jobs:
             This happens to ensure that the updates that happend on the release branch, i.e. CHANGELOG and manifest updates are also present on the dev branch.
 
       # if needed, you can checkout the latest master here, build artifacts and publish / deploy them somewhere
+      # the create-release action has an output `upload_url` output that you can use to upload assets