fix(changelog-check): add shouldExtractPrLinks to parseChangelog to populate prNumbers#159
Merged
Merged
Conversation
After updating to @metamask/auto-changelog v5.1.0 in PR #133, the parseChangelog function requires the shouldExtractPrLinks option to be set to true in order to populate the prNumbers array in changelog entries. Without this option, prNumbers would be empty, causing a runtime error when checking if the current PR number is included in the changelog entries. This fix ensures that PR links are properly extracted and validated during the changelog check process.
cryptodev-2s
changed the title
shouldExtractPrLinks to parseChangelog to populate prNumbers
mikesposito
approved these changes
Nov 6, 2025
4 tasks
cryptodev-2s
added a commit
to MetaMask/core
that referenced
this pull request
Nov 6, 2025
## Explanation Updates the `github-tools` changelog-check workflow to fix detection of `devDependencies`-only changes in `package.json`. ### What's Fixed The previous version failed to properly detect when `package.json` changes were only in `devDependencies` because the git diff logic required both the start and end of the `devDependencies` section to be visible. With limited diff context (`-U20`), the closing brace was often not included in the diff output. The new version increases git diff context from `-U20` to `-U9999` to ensure section headers are always visible, allowing proper detection of devDependencies-only changes. ### Changes - Updated `MetaMask/github-tools/.github/workflows/changelog-check.yml` from `fc6fe1a` to `bfb5e6f` (**PRs containing the fix** ([PR1](https://github.com/MetaMask/github-tools/pull/101), [PR2](MetaMask/github-tools#159)) <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> ## References <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? Are there client or consumer pull requests to adopt any breaking changes? For example: * Fixes #12345 * Related to #67890 --> ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Updates the changelog-check GitHub Actions workflow to use MetaMask/github-tools commit c0ec1c3. > > - **CI**: > - Update `changelog-check` reusable workflow reference and `action-sha` to `c0ec1c3` in `.github/workflows/changelog-check.yml`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 44a036e. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes a bug introduced in PR #133 when updating
@metamask/auto-changelogtov5.1.0.After the upgrade, the
parseChangelogfunction requires theshouldExtractPrLinksoption to be explicitly set to true in order to populate theprNumbersarray in changelog entries. Without this option, the prNumbers array would be empty, causing the changelog validation check to always fail when verifying that the current PR is documented in the changelog.Changes Made
Added shouldExtractPrLinks: true option to the parseChangelog call in checkChangelogFile function
Note
Cursor Bugbot is generating a summary for commit 744b10d. Configure here.