feat: parse `CHANGELOG entry:` and `no-changelog` #247

HowardBraham · 2025-09-01T15:28:05Z

Progresses: MetaMask/MetaMask-planning#5686

Looks for CHANGELOG entry: in the PR description, and looks for no-changelog label, then applies this to the generated CHANGELOG
Properly categorizes by Conventional Commit type, including our custom ConventionalCommitType.RELEASE

New parameters added:

useChangelogEntry: boolean;
useShortPrLink: boolean;

socket-security · 2025-09-01T15:28:28Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	universal-user-agent@6.0.1
	undici-types@6.21.0
	@octokit/openapi-types@24.2.0
	deprecation@2.3.1
	@octokit/plugin-request-log@4.0.1
	before-after-hook@2.2.3
	@octokit/auth-token@4.0.0
	@octokit/rest@20.1.2
	@octokit/endpoint@9.0.6
	@octokit/request-error@5.1.1
	@octokit/graphql@7.1.1
	@octokit/request@8.4.1
	@octokit/plugin-paginate-rest@11.4.4-cjs.2
	@octokit/core@5.2.2
	@octokit/plugin-rest-endpoint-methods@13.3.2-cjs.1

View full report

socket-security · 2025-09-01T15:28:30Z

All alerts resolved. Learn more about Socket for GitHub.

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring alerts on:

@octokit/[email protected]

View full report

HowardBraham · 2025-09-01T18:27:55Z

@SocketSecurity ignore @octokit/[email protected]

gauthierpetetin

Thanks for this PR @HowardBraham , here are a few comments:

HowardBraham · 2025-09-03T17:47:33Z

Generating the changelog with auto-changelog adds an empty line after each title. However, this is not accepted by “yarn lint:changelog”.

I know about this, and it's why in the changelog-update branch I changed the command to "lint:changelog": "auto-changelog validate --prettier"

We could ensure all changelog entries start with lowercase for consistency.

Actually I think we should go in the opposite direction and start all of them with an UPPERCASE. This is what we used to do, if you look at CHANGELOG_OLDER.md.

We could introduce an "undocumented" category for commits without changelog entries (different from “uncategorized” category). Currently commits without changelog entries and commits with changelog entries are all mixed together, which gives the impression that commits without changelog entries are ok and don’t need to be reviewed, while in most cases, they’re not user-facing and need to be reviewed.

Is this going to resolve now that changelog entries are mandatory?

We could automatically ignore commits including the following strings:

This makes sense.

Not sure how useful that is but in our current changelog (example here), all entries start with:

“feat: ” if they’re in the “### Added” section

“update: ” if they’re in the “### Changed” section

“fix: ” if they’re in the “### Fixed” section

I think this is actually an unwanted temporary relic. In CHANGELOG_OLDER.md, there was none of this.

Finally, I noticed “metamask-extension” is hardcoded in the PR, which means it wouldn’t work for metamask-mobile repo. We should use a parameter to make it repo-agnostic.

Oh whoops, you're right, I was using that for testing.

HowardBraham · 2025-09-03T23:37:43Z

@gauthierpetetin

Descriptions coming from CHANGELOG entry: now start with an uppercase letter
Ignores commits containing keywordsToIndicateExcluded
metamask-extension no longer hardcoded

gauthierpetetin · 2025-09-04T11:58:46Z

Thanks for the changes. I tried it out, here's the output I get for 13.3.0:

## [13.3.0]

### Uncategorized

- chore: Update Ocap kernel packages and patch @endo/env-options (#35526)
- chore: Bump main version to 13.4.0 (#35504)
- Improved multichain address list by filtering out test networks and refining layout (#35380)
- INFRA-2867: Skip version bump PR creation if already exists, commit in main (#35480)
- Bitcoin v1 release. (#35404)
- chore: migrate swap experience to BIP-44 selectors (#35220)
- INFRA-2867: Update inputs for workflow, update input parameter (#35399)
- chore: replace deprecated button components (#34098)
- chore: bump {`ens`,`gas-fee`,`notification-services`}-controller to {`^17`,`^24`,`^16`} (#35360)
- chore(deps): bump @metamask/message-signing-snap to v1.1.3 (#34364)
- chore: bump assets controllers to v73.3.0 (#35283)
- chore: Bump Snaps packages (#35356)
- Updated portfolio.metamask.io links to app.metamask.io (#35221)
- Bitcoin uses DIN endpoints (#35275)
- Upgraded @metamask/design-system-react to v0.3.1 for improved security and React 17 compatibility (#35271)
- chore: rm deprecated CrossChainSwaps events (#35127)
- chore: New Crowdin translations by Github Action (#34367)
- chore: update [email protected] (#35179)
- Bump bitcoin to v0.19.0 (#35230)
- chore: Bump main version to 13.3.0 (#35177)

### Added

- feat: Adding designs for amount input (#35510)
- feat: bump solana snap (#35511)
- feat: adding utility method for routing to send page (#35505)
- feat: capture amount metrics events (#35503)
- feat: Add max button to amount page (#35474)
- feat: Implementing send metrics context and hooks (#35461)
- feat: update SeedlessOnboarding controller to v3 (#35413)
- feat: send page implement navigations (#35416)
- feat: MetaMask Shield: Integrate Security Gateway (#35407)
- feat: swaps-2834 adds bitcoin multichain bridge chain (#35377)
- Added updates to wallet details page to handle multichain accounts (#35182)
- feat: add end-to-end tests for Trezor ERC20 token creation and management (#35382)
- feat: deprecating carousel slides (#35109)
- feat: Submit solana send to solana snap for review (#35361)
- feat: Adding amount fiat conversion and validation functions (#35346)
- feat: Add security alerts config option (#35396)
- feat: Adding header component on send page (#35326)
- feat: Display balance on amount page (#35246)
- Added a new page to display multichain account details (#35298)
- feat: Action to handle submit for EVM send (#35188)
- feat: pass asset over to send page in url parameters (#35115)
- feat: Add send context and page navigation (#35106)
- Improve dapp connection UX when the wallet is locked (#35122)
- feat: address scan internal transaction (#34978)
- Update documentation for point to the `stable` branch instead of `master`. (#34898)
- feat: Add `useSnapNameResolution` hook (#35113)
- feat(base branch): make it possible to define name of release PR base branch (#35194)
- feat: Adding a basic send page behind an env variable (#35104)
- Added new multichain account popup menu (#35064)

### Fixed

- Fixed source for multichain account names in account picker (#35478)
- fix: plan 966 enhance ledger not supported error (#35291)
- fix: wallet lock race-condition (#35022)
- fix: insufficient number of locale subs in account-exists/not-found pages (#35414)
- Fix long account name rendering (#35343)
- fix: Clear button does not clear all textboxes with 24 words (#33364)
- fix: transactions from multiple different networks not correctly displayed in activity tab (#35231)
- fix: Fixing issue in permit signature metrics (#35203)
- fix: Remove use of networkClientId for global network to get next nonce. (#35204)
- fix: Fix mapping simulation total value for bridge and swap transaction (#35196)
- fix(action): github-tools version was not properly updated (#35197)
- Fix ui not loading in old browsers due to use `Promise.withResolvers` (#35175)
- fix: Allow Snap confirmations during chain switching (#35107)
- fix: Apply DOMPurify patch to all instances (#35169)
- fix: Unified Swaps QuotesReceived and tx event properties (#35048)
- fix: fetch swap/bridge src balances after setting quote params (#35008)

It looks good, but I think we can make some things even cleaner.

Some lines start with a feat/fix prefix, some don't. I think we should either have it for every line, or remove it from every line.
We should have a "### Changed" category, gathering all PRs with "chore:" prefix. It seems they currently fall under "### Uncategorized"
PRs with "INFRA-" or "New Crowdin translations" prefixes have not been ignored. It seems the strings included in keywordsToIndicateExcluded need to be set to lowercase.

MajorLift · 2025-09-17T16:46:42Z

src/update-changelog.ts

+  const keywordsToIndicateExcludedLowerCase = keywordsToIndicateExcluded.map(
+    (word) => word.toLowerCase(),
+  );
+
+  return keywordsToIndicateExcludedLowerCase.some((word) =>
+    _description.includes(word),
+  );


nit: might shave off a bit of time complexity?

Suggested change

const keywordsToIndicateExcludedLowerCase = keywordsToIndicateExcluded.map(

(word) => word.toLowerCase(),

);

return keywordsToIndicateExcludedLowerCase.some((word) =>

_description.includes(word),

);

return keywordsToIndicateExcluded.some((word) => {

const pattern = new RegExp(word, 'u');

return Boolean(_description.match(pattern));

});

You were on to something here, but actually there was an even better time complexity solution, implemented in 3ea27a8

MajorLift · 2025-09-17T16:55:48Z

src/update-changelog.ts

+  // Create a regex pattern that matches any of the ConventionalCommitTypes
+  const typesWithPipe = conventionalCommitTypes.join('|');
+  const conventionalCommitPattern = new RegExp(
+    `^(${typesWithPipe})\\s*(\\([^)]*\\))?:.*$`,


Nice to see that parentheses e.g. build(deps): are supported.👍

MajorLift

This should be a great qol improvement for all contributors! LGTM

…tries

…other repos

gauthierpetetin · 2025-09-18T12:42:38Z

Hi @howard.braham,
I did some testing again before merging the PR and identified edge cases that needed to be fixed:

Support edge case where PR description includes multiple changelog entries --> Example PR that was causing issues
Make changelog generation idempotent for multi-line changelog entries --> Example PR that was causing issues
Gracefully handle edge case where changelog entries include links to other repos --> Example PR that was causing issues

I also re-tested everything locally and it looks good to me, I guess we can merge now.

MajorLift

LGTM!

MajorLift · 2025-09-18T17:31:18Z

src/parse-changelog.ts

 * @param repoUrl - The URL for the GitHub repository.
 * @returns The repository name, or null if it could not be determined.
 */
 function extractRepoName(repoUrl: string): string {


Suggested change

function extractRepoName(repoUrl: string): string {

function extractRepoName(repoUrl: string | undefined): string {

HowardBraham added 2 commits August 31, 2025 04:07

parse "CHANGELOG entry:"

93d2aeb

use Octokit to get labels

7ecd94d

HowardBraham self-assigned this Sep 1, 2025

HowardBraham changed the title ~~Parse changelog entry~~ feat: parse CHANGELOG entry: and no-changelog Sep 1, 2025

HowardBraham added 2 commits September 1, 2025 13:50

fixed existing yarn test issues

8f6dd3e

should support useChangelogEntry=true

6c34f9b

Fixed compatibility test by locking "@types/node" to "^22.18.0"

d6d7786

gauthierpetetin reviewed Sep 3, 2025

View reviewed changes

HowardBraham force-pushed the parse-changelog-entry branch from b9bf454 to 7291552 Compare September 3, 2025 23:36

HowardBraham added 3 commits September 3, 2025 19:39

no more hardcoded repo

d92b916

Make description start with an uppercase letter

1c6d96b

ignore commits including certain strings

2988fe3

HowardBraham force-pushed the parse-changelog-entry branch from 7291552 to 2988fe3 Compare September 3, 2025 23:39

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

29cb06a

gauthierpetetin mentioned this pull request Sep 10, 2025

Parse changelog entry adjustments #248

Merged

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

f3d6897

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

65c9c9e

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

b563be3

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

110414a

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

698cdf7

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

8d2c8f8

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 10, 2025

Test changelog automation MetaMask/auto-changelog#247

dccf2d3

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 11, 2025

Test changelog automation MetaMask/auto-changelog#247

4b4916c

XxdpavelxX added a commit to MetaMask/github-tools that referenced this pull request Sep 11, 2025

Test changelog automation MetaMask/auto-changelog#247

edf3aad

MajorLift reviewed Sep 17, 2025

View reviewed changes

MajorLift previously approved these changes Sep 17, 2025

View reviewed changes

HowardBraham added the do-not-merge label Sep 17, 2025

HowardBraham closed this Sep 17, 2025

HowardBraham reopened this Sep 17, 2025

HowardBraham marked this pull request as draft September 17, 2025 17:46

shave off a bit of time complexity

3ea27a8

HowardBraham dismissed MajorLift’s stale review via 3ea27a8 September 17, 2025 21:26

HowardBraham marked this pull request as ready for review September 17, 2025 21:27

HowardBraham requested review from MajorLift and gauthierpetetin September 17, 2025 22:45

MajorLift previously approved these changes Sep 18, 2025

View reviewed changes

gauthierpetetin added 3 commits September 18, 2025 14:32

Support edge case where PR description includes multiple changelog en…

42b4068

…tries

Make changelog generation idempotent for multi-line changelog entries

f5ac2da

Gracefully handle edge case where changelog entries include links to …

f262bce

…other repos

gauthierpetetin dismissed MajorLift’s stale review via f262bce September 18, 2025 12:32

Add more explicit comment

1ff6678

This comment was marked as outdated.

Sign in to view

gauthierpetetin and others added 2 commits September 18, 2025 18:44

Handle edge case where repoUrl is undefined

ac01428

added a CHANGELOG entry 🙂

9b65fa4

HowardBraham removed the do-not-merge label Sep 18, 2025

gauthierpetetin approved these changes Sep 18, 2025

View reviewed changes

HowardBraham enabled auto-merge (squash) September 18, 2025 17:14

HowardBraham requested a review from MajorLift September 18, 2025 17:27

MajorLift approved these changes Sep 18, 2025

View reviewed changes

HowardBraham merged commit f8c5f7d into main Sep 18, 2025
26 checks passed

HowardBraham deleted the parse-changelog-entry branch September 18, 2025 17:31

gauthierpetetin mentioned this pull request Dec 5, 2025

release: 13.13.0 MetaMask/metamask-extension#38575

Merged

14 tasks

	function extractRepoName(repoUrl: string): string {
	function extractRepoName(repoUrl: string \| undefined): string {

Uh oh!

feat: parse CHANGELOG entry: and no-changelog #247

feat: parse CHANGELOG entry: and no-changelog #247

Uh oh!

Conversation

HowardBraham commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HowardBraham commented Sep 1, 2025

Uh oh!

gauthierpetetin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HowardBraham commented Sep 3, 2025

Uh oh!

HowardBraham commented Sep 3, 2025

Uh oh!

gauthierpetetin commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MajorLift Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

HowardBraham Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

MajorLift Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

MajorLift left a comment

Choose a reason for hiding this comment

Uh oh!

gauthierpetetin commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

MajorLift left a comment

Choose a reason for hiding this comment

Uh oh!

MajorLift Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

feat: parse `CHANGELOG entry:` and `no-changelog` #247

feat: parse `CHANGELOG entry:` and `no-changelog` #247

HowardBraham commented Sep 1, 2025 •

edited

Loading

socket-security bot commented Sep 1, 2025 •

edited

Loading

socket-security bot commented Sep 1, 2025 •

edited

Loading

gauthierpetetin left a comment •

edited

Loading

gauthierpetetin commented Sep 4, 2025 •

edited

Loading

gauthierpetetin commented Sep 18, 2025 •

edited

Loading