feat: add require-pr-numbers flag for changelog generation (#181)

* feat: add require-pr-numbers flag for changelog generation

Add --requirePrNumbers flag to filter out direct commits without PR numbers from
changelogs. This helps maintain changelog quality for projects using strict PR-based
workflows.

Changes:
- Add require-pr-numbers input to update-release-changelog and create-release-pr actions
- Make --requirePrNumbers flag conditional based on input (defaults to false)
- Add merge logic to sync changelog branch with release branch updates

Requires @metamask/[email protected] with --requirePrNumbers support.

* fix: address Copilot review comments

- Replace eval with direct command execution for security
- Add platform-specific logic to create-platform-release-pr.sh
  (extension uses yarn, mobile uses npx with pinned version)
- Clarify documentation that require_pr_numbers is ignored for mobile
- Add detailed comment explaining merge logic rationale in
  update-release-changelog.sh (intentionally different from
  create-platform-release-pr.sh)

* chore: update @metamask/auto-changelog to ^5.3.0

Update to use the published version with --requirePrNumbers support.

* fix: address additional Copilot review comments

- Fix typo: 'heckout_or_create_branch' -> 'checkout_or_create_branch'
- Improve merge conflict handling: reset to HEAD (pre-merge state)
  instead of release branch to preserve existing changelog content
- Add clearer logging for merge conflict scenario

Note: Code duplication suggestion skipped (nitpick, over-engineering)

* refactor: streamline changelog generation logic

- Consolidate changelog generation for both extension and mobile platforms to use yarn auto-changelog.
- Remove redundant merge logic in update-release-changelog.sh to simplify the process.
- Ensure consistent handling of the --requirePrNumbers flag across scripts for improved clarity and functionality.

* fix: correct variable name and fix package.json formatting

- Fix bug: ${new_version} -> ${VERSION} in update-release-changelog.sh
- Add trailing newline to package.json for Prettier compliance

* docs: remove platform-specific limitation from require_pr_numbers

Standardize changelog generation for both platforms. The require-pr-numbers
flag can now be used for both extension and mobile, though it's currently
only enabled for extension.

* refactor: always use --requirePrNumbers flag

Remove conditional require-pr-numbers parameter and always apply
the --requirePrNumbers flag to filter out direct commits.

This simplifies the code as both extension and mobile teams have
agreed to use this behavior by default.

Author: Qbandev

.github/scripts/create-platform-release-pr.sh

@@ -347,8 +347,13 @@ create_changelog_pr() {
 
     # Generate Changelog and Test Plan
     echo "Generating changelog for ${platform}.."
-    yarn auto-changelog update --rc --repo "${GITHUB_REPOSITORY_URL}" --currentVersion "${new_version}" --autoCategorize --useChangelogEntry --useShortPrLink
-
+    yarn auto-changelog update --rc \
+        --repo "${GITHUB_REPOSITORY_URL}" \
+        --currentVersion "${new_version}" \
+        --autoCategorize \
+        --useChangelogEntry \
+        --useShortPrLink \
+        --requirePrNumbers
 
     # Skip commits.csv for hotfix releases (previous_version_ref is literal "null")
     # - When we create a new major/minor release, we fetch all commits included in the release, by fetching the diff between HEAD and previous version reference.

.github/scripts/update-release-changelog.sh

@@ -200,13 +200,15 @@ CHANGELOG_BRANCH=$(determine_changelog_branch "${VERSION}")
 checkout_or_create_branch "${CHANGELOG_BRANCH}" "${RELEASE_BRANCH}"
 
 echo "Generating changelog for ${PLATFORM} ${VERSION}.."
-if [[ "${PLATFORM}" == "extension" ]]; then
-    yarn auto-changelog update --rc --repo "${GITHUB_REPOSITORY_URL}" --currentVersion "${VERSION}" --autoCategorize --useChangelogEntry --useShortPrLink
-else
-    npx @metamask/[email protected] update --rc --repo "${GITHUB_REPOSITORY_URL}" --currentVersion "${VERSION}" --autoCategorize
-fi
+
+yarn auto-changelog update --rc \
+    --repo "${GITHUB_REPOSITORY_URL}" \
+    --currentVersion "${VERSION}" \
+    --autoCategorize \
+    --useChangelogEntry \
+    --useShortPrLink \
+    --requirePrNumbers
 
 # commits.csv generation removed (no longer required)
 
 commit_and_push_changelog "${VERSION}" "${PREVIOUS_VERSION_REF}" "${CHANGELOG_BRANCH}" "${RELEASE_BRANCH}"
-

package.json

@@ -26,7 +26,7 @@
     "update-release-sheet": "node .github/scripts/update-release-sheet.mjs"
   },
   "dependencies": {
-    "@metamask/auto-changelog": "^5.2.0",
+    "@metamask/auto-changelog": "^5.3.0",
     "@metamask/utils": "^7.1.0",
     "@octokit/graphql": "^7.0.1",
     "@octokit/request": "^8.1.1",

yarn.lock

@@ -941,9 +941,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/auto-changelog@npm:^5.2.0":
-  version: 5.2.0
-  resolution: "@metamask/auto-changelog@npm:5.2.0"
+"@metamask/auto-changelog@npm:^5.3.0":
+  version: 5.3.0
+  resolution: "@metamask/auto-changelog@npm:5.3.0"
   dependencies:
     "@octokit/rest": "npm:^20.0.0"
     diff: "npm:^5.0.0"
@@ -954,7 +954,7 @@ __metadata:
     prettier: ">=3.0.0"
   bin:
     auto-changelog: dist/cli.mjs
-  checksum: 10/86ca4f56a0c86a1fabbe4b7b66a28bda39e59c51c996aadedeb5f341b3e93acfd7ca5dafebbd82852070f12324bbd83fc7cb979cb9f8b9ca8f5dded53f1fa5af
+  checksum: 10/5381c2b1efbade000bafbbee7b1becbee1787b9f24849352d16ddd3b14f511f865b3478250301f3d22f98fe0208690f62f166a476e64d38ed58361d816a673b6
   languageName: node
   linkType: hard
 
@@ -1014,7 +1014,7 @@ __metadata:
   dependencies:
     "@lavamoat/allow-scripts": "npm:^2.3.1"
     "@lavamoat/preinstall-always-fail": "npm:^1.0.0"
-    "@metamask/auto-changelog": "npm:^5.2.0"
+    "@metamask/auto-changelog": "npm:^5.3.0"
     "@metamask/eslint-config": "npm:^12.0.0"
     "@metamask/eslint-config-jest": "npm:^12.0.0"
     "@metamask/eslint-config-nodejs": "npm:^12.0.0"