fix: changelog generation formatting RE-3152

.changeset/changelog-generator.js

@@ -0,0 +1,105 @@
+/*
+ * Based off of https://github.com/changesets/changesets/blob/7323704dff6e76f488370db384579b86c95c866f/packages/changelog-github/src/index.ts
+ */
+
+const ghInfo = require("@changesets/get-github-info");
+
+const getDependencyReleaseLine = async (changesets, dependenciesUpdated, options) => {
+  if (dependenciesUpdated.length === 0) return "";
+  if (!options || !options.repo) {
+    throw new Error(
+      'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+    );
+  }
+
+  const changesetLink = `- Updated dependencies [${(
+    await Promise.all(
+      changesets.map(async (cs) => {
+        if (cs.commit) {
+          let { links } = await ghInfo.getInfo({
+            repo: options.repo,
+            commit: cs.commit,
+          });
+          return links.commit;
+        }
+      })
+    )
+  )
+    .filter((_) => _)
+    .join(", ")}]:`;
+
+
+  const updatedDepsList = dependenciesUpdated.map(
+    (dependency) => `  - ${dependency.name}@${dependency.newVersion}`
+  );
+
+  return [changesetLink, ...updatedDepsList].join("\n");
+};
+
+const getReleaseLine = async (changeset, _, options) => {
+  if (!options || !options.repo) {
+    throw new Error(
+      'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+    );
+  }
+
+  let prFromSummary;
+  let commitFromSummary;
+
+  const replacedChangelog = changeset.summary
+    .replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+      let num = Number(pr);
+      if (!isNaN(num)) prFromSummary = num;
+      return "";
+    })
+    .replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+      commitFromSummary = commit;
+      return "";
+    })
+    .trim();
+
+  const [firstLine, ...futureLines] = replacedChangelog
+    .split("\n")
+    .map((l) => l.trimRight());
+
+  const links = await (async () => {
+    if (prFromSummary !== undefined) {
+      let { links } = await ghInfo.getInfoFromPullRequest({
+        repo: options.repo,
+        pull: prFromSummary,
+      });
+      if (commitFromSummary) {
+        const shortCommitId = commitFromSummary.slice(0, 7);
+        links = {
+          ...links,
+          commit: `[\`${shortCommitId}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`,
+        };
+      }
+      return links;
+    }
+    const commitToFetchFrom = commitFromSummary || changeset.commit;
+    if (commitToFetchFrom) {
+      let { links } = await ghInfo.getInfo({
+        repo: options.repo,
+        commit: commitToFetchFrom,
+      });
+      return links;
+    }
+    return {
+      commit: null,
+      pull: null,
+      user: null,
+    };
+  })();
+
+  const prefix = [
+    links.pull === null ? "" : ` ${links.pull}`,
+    links.commit === null ? "" : ` ${links.commit}`,
+  ].join("");
+
+  return `\n\n-${prefix ? `${prefix} -` : ""} ${firstLine}\n${futureLines
+    .map((l) => `  ${l}`)
+    .join("\n")}`;
+};
+
+module.exports = { getReleaseLine, getDependencyReleaseLine };

.changeset/config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
   "changelog": [
-    "@changesets/changelog-github",
+    "./changelog-generator.js",
     {
       "repo": "smartcontractkit/chainlink"
     }

.changeset/tasty-years-behave.md

@@ -0,0 +1,5 @@
+---
+"chainlink": patch
+---
+
+Modify release changelog generation format #internal

.github/workflows/changeset.yml

@@ -52,7 +52,7 @@ jobs:
               - '!core/chainlink.Dockerfile'
               - '!core/gethwrappers/**'
             core-changeset:
-              - added: '.changeset/**'
+              - added: '.changeset/*.md'
 
       - name: Check for changeset tags for core
         id: changeset-tags

contracts/.changeset/config.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://unpkg.com/@changesets/config@2.3.1/schema.json",
   "changelog": [
-    "@changesets/changelog-github",
+    "../../.changeset/changelog-generator.js",
     {
       "repo": "smartcontractkit/chainlink"
     }

contracts/package.json

@@ -80,8 +80,8 @@
   "dependencies": {
     "@arbitrum/nitro-contracts": "1.1.1",
     "@arbitrum/token-bridge-contracts": "1.1.2",
-    "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "~2.27.8",
+    "@changesets/get-github-info": "^0.6.0",
     "@eth-optimism/contracts": "0.6.0",
     "@openzeppelin/contracts": "4.9.3",
     "@openzeppelin/contracts-upgradeable": "4.9.3",

package.json

@@ -22,8 +22,8 @@
     "pnpm": ">=9"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "~2.26.2",
+    "@changesets/get-github-info": "^0.6.0",
     "semver": "^7.6.3"
   }
 }