Skip to content

Enable PR link validation in changelogs by default#8637

Draft
mcmire wants to merge 1 commit intomainfrom
fix-bad-pr-links-in-changelogs
Draft

Enable PR link validation in changelogs by default#8637
mcmire wants to merge 1 commit intomainfrom
fix-bad-pr-links-in-changelogs

Conversation

@mcmire
Copy link
Copy Markdown
Contributor

@mcmire mcmire commented Apr 29, 2026

Explanation

  • Pass --prLinks to auto-changelog validate by default to check that all changelog entries have associated PR links and that the list of PR links is formatted correctly.
  • Correct existing changelogs to satisfy the new validation changes.

References

--prLinks was added to auto-changelog a while back, but it hasn't been enabled so far in this repo.

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
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

- Pass `--prLinks` to `auto-changelog validate` by default to check that
  all changelog entries have associated PR links and that the list of PR
  links is formatted correctly.
- Correct existing changelogs to satisfy the new validation changes.
### Changed

- **BREAKING:** Bump peer dependency `@metamask/keyring-controller` from `^18.0.0` to `^19.0.0` ([#4915](https://github.com/MetaMask/core/pull/4956))
- **BREAKING:** Bump peer dependency `@metamask/keyring-controller` from `^18.0.0` to `^19.0.0` ([#4915](https://github.com/MetaMask/core/pull/4915))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#4915 was a release that included keyring-controller.

### Changed

- **BREAKING:** Bump dependency and peer dependency on `@metamask/keyring-controller` to ^9.0.0
- **BREAKING:** Bump dependency and peer dependency on `@metamask/keyring-controller` to ^9.0.0 ([#2052](https://github.com/MetaMask/core/pull/2052))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entry was missing a PR link.

#2052 was a release that included keyring-controller.

- Bump dependency on `@metamask/utils` to ^8.1.0 ([#1639](https://github.com/MetaMask/core/pull/1639))
- Bump dependency on `@metamask/base-controller` to ^3.2.3
- Bump peer dependency on `@metamask/keyring-controller` to ^8.0.2
- Bump dependency on `@metamask/base-controller` to ^3.2.3 ([#1747](https://github.com/MetaMask/core/pull/1747))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1747 was a release that included base-controller.

### Changed

- **BREAKING:** Bump peer dependency on `@metamask/keyring-controller` to ^8.0.0
- **BREAKING:** Bump peer dependency on `@metamask/keyring-controller` to ^8.0.0 ([#1708](https://github.com/MetaMask/core/pull/1708))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1708 was a release that included keyring-controller.

- Bump dependency on `@metamask/utils` to ^8.1.0 ([#1639](https://github.com/MetaMask/core/pull/1639))
- Bump dependency on `@metamask/base-controller` to ^3.2.3
- Bump dependency on `@metamask/controller-utils` to ^5.0.2
- Bump dependency on `@metamask/base-controller` to ^3.2.3 ([#1747](https://github.com/MetaMask/core/pull/1747))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1747 was a release that included base-controller.

- Bump dependency on `@metamask/base-controller` to ^3.2.3
- Bump dependency on `@metamask/controller-utils` to ^5.0.2
- Bump dependency and peer dependency on `@metamask/network-controller` to ^14.0.0
- Bump dependency on `@metamask/base-controller` to ^3.2.3 ([#1747](https://github.com/MetaMask/core/pull/1747))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing links to #1747 (a release that included these packages).

- Bump dependency on `@metamask/base-controller` to ^3.2.1
- Bump dependency on `@metamask/controller-utils` to ^4.3.2
- Bump dependency and peer dependency on `@metamask/network-controller` to ^12.1.2
- Bump dependency on `@metamask/base-controller` to ^3.2.1 ([#1634](https://github.com/MetaMask/core/pull/1634))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing links to #1634 (a release that included these packages).


- Upgrade `@metamask/utils` from `^11.8.1` to `^11.9.0` ([#7511](https://github.com/MetaMask/core/pull/7511))
- **BREAKING:** Changed `wallet_requestExecutionPermissions` to comply with 7715 spec revisions.
- **BREAKING:** Changed `wallet_requestExecutionPermissions` to comply with 7715 spec revisions ([#7603](https://github.com/MetaMask/core/pull/7603))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing link to #7603.

- Bump `@metamask/network-controller` from `^24.2.2` to `^24.3.0` ([#6883](https://github.com/MetaMask/core/pull/6883))
- This package was migrated from `MetaMask/eth-json-rpc-middleware` to the
`MetaMask/core` monorepo.
- This package was migrated from `MetaMask/eth-json-rpc-middleware` to the `MetaMask/core` monorepo ([#6866](https://github.com/MetaMask/core/pull/6866))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing link to #6866.

### Changed

- Add missing ISC license information ([#24](https://github.com/MetaMask/eth-json-rpc-provider/pull/24))
- Add missing ISC license information ([#1855](https://github.com/MetaMask/core/pull/1855))
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm.... this is not right. We need to keep these original links. I guess we'll have to add a new option to auto-changelog to accommodate this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant