Customize GH release notes & add tarball

I wasn't extremely happy with the default github-generated release
notes, specifically the changelog tag detection, so I used the
suggestions I found in the softprops repo: mikepenz's
release-changelog-builder-action.

Added .github/changelog.json to customize the labels, categories, and
output templates for the release notes.

For it to work how I'd like, I had to manually construct the compare
link from the action's detected tags and manually construct the NPM
package url.

Also had to add a manual npm pack step in order to provide the .tgz in
the GitHub release assets, but that can be removed if desired.

Author: TheMrCam

.github/changelog.json

@@ -0,0 +1,31 @@
+{
+  "categories": [
+    {
+      "title": "## ⚙️ Breaking",
+      "labels": ["breaking"]
+    },
+    {
+      "title": "## 🚀 Features",
+      "labels": ["feature", "enhancement"]
+    },
+    {
+      "title": "## 🐛 Fixes",
+      "labels": ["fix", "bugfix"]
+    },
+    {
+      "title": "## 📜 Documentation",
+      "labels": ["documentation", "docs"]
+    },
+    {
+      "title": "## 🛠️ Infrastructure",
+      "labels": ["dependencies", "maintenance", "ci"]
+    },
+    {
+      "title": "## 💬 Uncategorized",
+      "labels": []
+    }
+  ],
+  "ignore_labels": ["ignore", "ci-ignore"],
+  "template": "#{{CHANGELOG}}",
+  "pr_template": "- #{{TITLE}} (##{{NUMBER}} by @#{{AUTHOR}})"
+}

.github/workflows/release.yml

@@ -24,16 +24,30 @@ jobs:
       - uses: JS-DevTools/npm-publish@v3
         with:
           token: ${{ secrets.NPM_TOKEN }}
+      # see https://github.com/softprops/action-gh-release/pull/372#issuecomment-1642643937
+      - name: Create release notes
+        id: build_changelog
+        uses: mikepenz/release-changelog-builder-action@v5
+        with:
+          configuration: '.github/changelog.json'
+          ignorePreReleases: ${{ ! contains(github.ref_name, '-') }}
+      - name: Create tarball
+        run: npm pack --ignore-scripts
       - name: Create release
         id: create_release
         uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ github.ref }}
           name: Release ${{ github.ref_name }}
-          body: ""
-          generate_release_notes: true
+          body: |
+            ${{ steps.build_changelog.outputs.changelog }}
+
+            **${{ contains(github.ref_name, '-') && 'Prerelease' || 'Full' }} changelog:** ${{ github.server_url }}/${{ github.repository }}/compare/${{ steps.build_changelog.outputs.fromTag }}...${{ steps.build_changelog.outputs.toTag }}
+            **NPM release:** https://npmjs.com/package/${{ steps.publish.outputs.name }}/v/${{ steps.publish.outputs.version }}
           draft: true
-          prerelease: false
+          prerelease: ${{ contains(github.ref_name, '-') }}
+          files: |
+            *.tgz
       - name: action-slack
         uses: 8398a7/[email protected]
         with: