Improving "publish release" workflow (#4898)

* Update publish-release.yml * Update publish-release.yml * Update publish-release.yml * Update publish-release.yml * Update publish-release.yml * Update publish-release.yml * Extracting changelog using a JS script * Updated the naming when slacking * Reverting comments * Arming the slack action * Adding a note on the forked action * Update .gitignore
realm · Sep 13, 2022 · a7c8c9f · a7c8c9f
1 parent 2ed4a42
commit a7c8c9f
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 15 deletions.
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -88,7 +88,8 @@ jobs:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
     - name: Find Release PR
-      uses: juliangruber/find-pull-request-action@f9f7484f8237cf8485e5ab826e542ba5dd9e9c6e
+      # TODO: Revert this to upstream action once https://github.com/juliangruber/find-pull-request-action/pull/33 gets merged
+      uses: kraenhansen/find-pull-request-action@master
       id: find-pull-request
       with:
         branch: ${{ github.ref }}
@@ -100,13 +101,19 @@ jobs:
         number: ${{ steps.find-pull-request.outputs.number }}
         method: squash
 
+    - name: Checkout base branch (after merge)
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        ref: ${{ github.event.pull_request.base.ref }}
+
     - name: Extract Changelog
-      run: scripts/extract-changelog.sh ${{ steps.get-version.outputs.version }} > ExtractedChangelog.md
+      run: node scripts/extract-changelog.js ${{ steps.get-version.outputs.version }} > EXTRACTED_CHANGELOG.md
 
     - name: Create Github Release
       uses: ncipollo/release-action@10c84d509b28aae3903113151bfd832314964f2e
       with:
-        bodyFile: ExtractedChangelog.md
+        bodyFile: EXTRACTED_CHANGELOG.md
         name: ${{ steps.get-version.outputs.version }}
         tag: v${{ steps.get-version.outputs.version }}
         token: ${{ secrets.GITHUB_TOKEN }}
@@ -116,8 +123,8 @@ jobs:
     - name: 'Post to #realm-releases'
       uses: realm/ci-actions/release-to-slack@v3
       with:
-        changelog: ExtractedChangelog.md
-        sdk: JS
+        changelog: EXTRACTED_CHANGELOG.md
+        sdk: JavaScript
         webhook-url: ${{ secrets.SLACK_RELEASE_WEBHOOK }}
         version: ${{ steps.get-version.outputs.version }}
       # This job might fail due to failed markdown-to-slack conversion.
@@ -135,7 +142,7 @@ jobs:
         body: Update Changelog for vNext
         delete-branch: true
         commit-message: Prepare for vNext
-        base: master
+        base: ${{ steps.find-pull-request.outputs.base-ref }}
 
     - name: Merge Pull Request
       uses: juliangruber/merge-pull-request-action@8a13f2645ad8b6ada32f829b2fae9c0955a5265d

diff --git a/.gitignore b/.gitignore
@@ -19,7 +19,7 @@ vendor/realm-*
 !vendor/realm-core
 
 # extracted changelog
-ExtractedChangelog.md
+EXTRACTED_CHANGELOG.md
 
 # jsdoc
 /docs/output

diff --git a/scripts/extract-changelog.js b/scripts/extract-changelog.js
@@ -0,0 +1,41 @@
+////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2022 Realm Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+////////////////////////////////////////////////////////////////////////////
+
+const fs = require("node:fs");
+const path = require("node:path");
+
+function extractRelease(changelog, expectedVersion) {
+  // Inspired by https://github.com/realm/ci-actions/blob/main/update-changelog/src/helpers.ts
+  const changelogRegex = /^## (?<version>[^\s]+) \((?<date>[^)]+)\)\s+(?<body>.*?)\s+(?=^## )/gms;
+  let match;
+  while ((match = changelogRegex.exec(changelog))) {
+    const release = match.groups;
+    if (!expectedVersion || expectedVersion === release.version) {
+      return release;
+    }
+  }
+  throw new Error("Unable to extract release");
+}
+
+if (require.main === module) {
+  const changelogPath = path.resolve(__dirname, "../CHANGELOG.md");
+  const changelog = fs.readFileSync(changelogPath, { encoding: "utf8" });
+  const version = process.argv[2];
+  const release = extractRelease(changelog, version);
+  console.log(release.body);
+}
diff --git a/scripts/extract-changelog.sh b/scripts/extract-changelog.sh