Skip to content

Commit 4f6037d

Browse files
authored
feat: enable require-pr-numbers flag for changelog generation (#38520)
## **Description** This PR updates the changelog workflows to use the new `@metamask/[email protected]` which always filters out direct commits without PR numbers. This ensures all changelog entries represent reviewed and approved changes. **Changes:** - Update `@metamask/auto-changelog` from `^5.1.0` to `^5.3.0` - Update workflows to use `[email protected]` which includes the `--requirePrNumbers` flag enabled by default The `--requirePrNumbers` flag is now always applied by default in github-tools, so no additional configuration is needed. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/38520?quickstart=1) ## **Changelog** CHANGELOG entry: null ## **Related issues** - ✅ [MetaMask/auto-changelog#253](MetaMask/auto-changelog#253) - Merged - ✅ [MetaMask/github-tools#181](MetaMask/github-tools#181) - Merged and released as v1.1.2 ## **Manual testing steps** 1. Tested on [consensys-test/metamask-extension-test](https://github.com/consensys-test/metamask-extension-test) with `release/1100.0.0` 2. Verified PR commits are included in changelog 3. Verified direct commits are excluded from changelog 4. See [generated changelog](https://github.com/consensys-test/metamask-extension-test/blob/release/1100.0.0-Changelog/CHANGELOG.md) ## **Screenshots/Recordings** ### **Before** Direct commits without PR numbers would appear in the changelog. ### **After** Only commits with PR numbers (representing reviewed changes) appear in the changelog. ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I've included tests if applicable - [x] I've documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I've applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.
1 parent 0dbf2b2 commit 4f6037d

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

.github/workflows/update-release-changelog.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ jobs:
4848
pull-requests: write
4949
steps:
5050
- name: Update Release Changelog
51-
uses: MetaMask/github-tools/.github/actions/[email protected].0
51+
uses: MetaMask/github-tools/.github/actions/[email protected].2
5252
with:
5353
release-branch: ${{ github.ref_name }}
5454
repository-url: ${{ github.server_url }}/${{ github.repository }}
5555
platform: extension
5656
previous-version-ref: 'null'
57-
github-tools-version: v1.1.0
57+
github-tools-version: v1.1.2
5858
github-token: ${{ secrets.PR_TOKEN }}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@
480480
"@lavamoat/lavapack": "^7.0.17",
481481
"@lydell/node-pty": "^1.1.0",
482482
"@metamask/api-specs": "^0.13.0",
483-
"@metamask/auto-changelog": "^5.1.0",
483+
"@metamask/auto-changelog": "^5.3.0",
484484
"@metamask/build-utils": "^3.0.0",
485485
"@metamask/eslint-config": "^9.0.0",
486486
"@metamask/eslint-config-jest": "^9.0.0",

yarn.lock

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5878,9 +5878,9 @@ __metadata:
58785878
languageName: node
58795879
linkType: hard
58805880

5881-
"@metamask/auto-changelog@npm:^5.1.0":
5882-
version: 5.1.0
5883-
resolution: "@metamask/auto-changelog@npm:5.1.0"
5881+
"@metamask/auto-changelog@npm:^5.3.0":
5882+
version: 5.3.0
5883+
resolution: "@metamask/auto-changelog@npm:5.3.0"
58845884
dependencies:
58855885
"@octokit/rest": "npm:^20.0.0"
58865886
diff: "npm:^5.0.0"
@@ -5891,7 +5891,7 @@ __metadata:
58915891
prettier: ">=3.0.0"
58925892
bin:
58935893
auto-changelog: dist/cli.mjs
5894-
checksum: 10/ee9f651c313a2377a21a304383f56f1872b4ce6411a0b61cf0b70b23bff9d3204332cd5a052cdfcaf363ce15424a7a1fdbde99a6b4352f2472fbe6b6d27c5791
5894+
checksum: 10/5381c2b1efbade000bafbbee7b1becbee1787b9f24849352d16ddd3b14f511f865b3478250301f3d22f98fe0208690f62f166a476e64d38ed58361d816a673b6
58955895
languageName: node
58965896
linkType: hard
58975897

@@ -33332,7 +33332,7 @@ __metadata:
3333233332
"@metamask/api-specs": "npm:^0.13.0"
3333333333
"@metamask/approval-controller": "npm:^8.0.0"
3333433334
"@metamask/assets-controllers": "patch:@metamask/assets-controllers@npm%3A92.0.0#~/.yarn/patches/@metamask-assets-controllers-npm-92.0.0-ea998cb0bd.patch"
33335-
"@metamask/auto-changelog": "npm:^5.1.0"
33335+
"@metamask/auto-changelog": "npm:^5.3.0"
3333633336
"@metamask/base-controller": "npm:^9.0.0"
3333733337
"@metamask/bitcoin-wallet-snap": "npm:^1.8.0"
3333833338
"@metamask/bridge-controller": "patch:@metamask/bridge-controller@npm%3A61.0.0#~/.yarn/patches/@metamask-bridge-controller-npm-61.0.0-8c413c463f.patch"

0 commit comments

Comments
 (0)