ci: release log for github (#1413)

### Description of Changes
Parse & format changelogs for github release note

### Notes & Questions About Changes
I couldn't really make the conventional changelog plugin work for the
GitHub release note as we want - at this point, it might be better to
use the plugin only to cover the version handling.

### Validation / Testing
look at the test release I cut from this branch:
https://github.com/NASA-IMPACT/veda-ui/releases (will delete it - and I
tweaked the header not to be capitalized after)

Author: hanbyul-here

.release-it.js

@@ -0,0 +1,68 @@
+const prefixes = {
+  feat: '🎉 Features',
+  fix: '🐛 Fixes',
+  docs: '🚀 Improvements',
+  ci: '🚀 Improvements',
+  test: '🚀 Improvements',
+  refactor: '🚀 Improvements',
+  chore: '🚀 Improvements',
+  revert: '🐛 Fixes'
+};
+
+function groupCommitsByCategory(logs) {
+  const grouped = {};
+
+  // Initialize categories from the values in the prefixes dictionary
+  Object.values(prefixes).forEach((category) => {
+    grouped[category] = [];
+  });
+
+  // Loop through each prefix to find conventional commit pattern ex. feat: , feat(card):
+  Object.entries(prefixes).forEach(([prefix, category]) => {
+    const regex = new RegExp(`^\\* ${prefix}(\\(.*?\\))?: .*?\\)$`, 'gm');
+    const matches = logs.match(regex) || [];
+    grouped[category] = [...matches, ...grouped[category]];
+  });
+
+  return grouped;
+}
+
+module.exports = {
+  hooks: {
+    'after:release': 'echo "VERSION_NUMBER=v${version}" >> "$GITHUB_OUTPUT" '
+  },
+  git: {
+    commitMessage: 'chore(release): update to version v${version}',
+    tagName: 'v${version}',
+    tagAnnotation: 'Release v${version}',
+    pushArgs: ['--follow-tags'],
+    getLatestTagFromAllRefs: true
+  },
+  npm: {
+    publish: false
+  },
+  github: {
+    release: true,
+    releaseName: 'v${version}',
+    autoGenerate: false,
+    releaseNotes: function (context) {
+      const groupedCommits = groupCommitsByCategory(context.changelog);
+      const changelog = Object.entries(groupedCommits)
+        .map(([prefix, commits]) => {
+          if (commits.length > 0) {
+            return `## What's changed \n ### ${prefix}\n ${commits.join('\n')}`;
+          }
+        })
+        .join('\n');
+
+      return changelog;
+    }
+  },
+  plugins: {
+    // The @release-it/conventional-changelog plugin is primarily used for handling version bumps
+    // because we encountered difficulties generating GitHub release notes with the plugin.
+    '@release-it/conventional-changelog': {
+      preset: 'conventionalcommits'
+    }
+  }
+};

.release-it.json

@@ -64,7 +64,7 @@
     "@parcel/transformer-typescript-types": "2.12.0",
     "@parcel/transformer-webmanifest": "2.7.0",
     "@playwright/test": "^1.46.1",
-    "@release-it/conventional-changelog": "^9.0.3",
+    "@release-it/conventional-changelog": "^10.0.0",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.1.0",

package.json

@@ -3934,10 +3934,10 @@
     "@babel/runtime" "^7.23.2"
     immutable "^4.3.4"
 
-"@release-it/conventional-changelog@^9.0.3":
-  version "9.0.3"
-  resolved "http://verdaccio.ds.io:4873/@release-it%2fconventional-changelog/-/conventional-changelog-9.0.3.tgz#4d8a4b07a7bba8c6ed151ea8ae75bca15d3219eb"
-  integrity sha512-+3TL+B89Kc+VTbfGxpTvJkbegWt5XIzkovsYVJyoZpOZDG07v25FU8c5R5Q8yNUs76Ikfq0sp+ZTTxmefG4Hiw==
+"@release-it/conventional-changelog@^10.0.0":
+  version "10.0.0"
+  resolved "http://verdaccio.ds.io:4873/@release-it%2fconventional-changelog/-/conventional-changelog-10.0.0.tgz#25a9b4785d59ea1c2dce9acafc3c0cc86552826f"
+  integrity sha512-49qf9phGmPUIGpY2kwfgehs9en1znbPv2zdNn1WMLAH9DtHUh4m6KNSB+mLFGAMUhv24JhsA8ruYRYgluc2UJw==
   dependencies:
     concat-stream "^2.0.0"
     conventional-changelog "^6.0.0"