feat: enable require-pr-numbers flag for changelog generation#38520
feat: enable require-pr-numbers flag for changelog generation#38520
Conversation
Update changelog workflows to filter out direct commits without PR numbers, ensuring all changelog entries represent reviewed and approved changes. Changes: - Update @metamask/auto-changelog to ^5.3.0 - Add require-pr-numbers: 'true' to update-release-changelog workflow - Add require-pr-numbers: 'true' to create-release-pr workflow
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Caution MetaMask internal reviewing guidelines:
|
Builds ready [1843af0]
UI Startup Metrics (1158 ± 91 ms)
📊 Page Load Benchmark ResultsCurrent Commit: 📄 Localhost MetaMask Test DappSamples: 100 Summary
📈 Detailed Results
Bundle size diffs [🚀 Bundle size reduced!]
|
The github-tools actions now always use --requirePrNumbers by default, so the parameter is no longer needed.
Builds ready [dfffec5]
UI Startup Metrics (1273 ± 111 ms)
📊 Page Load Benchmark ResultsCurrent Commit: 📄 Localhost MetaMask Test DappSamples: 100 Summary
📈 Detailed Results
Bundle size diffs [🚀 Bundle size reduced!]
|
Update workflows to use the released v1.1.2 version of github-tools which includes the --requirePrNumbers flag enabled by default.
There was a problem hiding this comment.
Pull request overview
This PR upgrades the changelog generation tooling to enforce that all changelog entries represent reviewed changes by filtering out direct commits without PR numbers. The upgrade involves updating the @metamask/auto-changelog package and the GitHub Actions workflows that use it.
Key changes:
- Upgrade
@metamask/auto-changelogfrom^5.1.0to^5.3.0to support PR number filtering - Update GitHub workflow actions to use
github-tools@v1.1.2which includes the--requirePrNumbersflag enabled by default
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
package.json |
Updates @metamask/auto-changelog dependency version from ^5.1.0 to ^5.3.0 |
yarn.lock |
Reflects the package.json change with updated version and checksum for @metamask/auto-changelog |
.github/workflows/update-release-changelog.yml |
Updates action reference from @v1.1.0 to @v1.1.2 and sets github-tools-version parameter to v1.1.2 |
.github/workflows/create-release-pr.yml |
Updates action reference from @v1.1.0 to @v1.1.2 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Builds ready [506f535]
UI Startup Metrics (1245 ± 107 ms)
📊 Page Load Benchmark ResultsCurrent Commit: 📄 Localhost MetaMask Test DappSamples: 100 Summary
📈 Detailed Results
Bundle size diffs [🚀 Bundle size reduced!]
|
Description
This PR updates the changelog workflows to use the new
@metamask/auto-changelog@5.3.0which always filters out direct commits without PR numbers. This ensures all changelog entries represent reviewed and approved changes.Changes:
@metamask/auto-changelogfrom^5.1.0to^5.3.0github-tools@v1.1.2which includes the--requirePrNumbersflag enabled by defaultThe
--requirePrNumbersflag is now always applied by default in github-tools, so no additional configuration is needed.Changelog
CHANGELOG entry: null
Related issues
Manual testing steps
release/1100.0.0Screenshots/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
Pre-merge reviewer checklist