-
Notifications
You must be signed in to change notification settings - Fork 5.4k
INFRA-2576: Created a new workflow that will create a changelog PR or update existing changelog #36907
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
… update existing changelog
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. |
release-branch: ${{ github.ref_name }} | ||
repository-url: ${{ github.server_url }}/${{ github.repository }} | ||
platform: extension | ||
github-tools-version: INFRA-2576-UpdateChangelogAutomatically |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Workflow Relies on Unstable Feature Branch
The workflow uses the temporary feature branch INFRA-2576-UpdateChangelogAutomatically
in its uses
statement and for the github-tools-version
parameter. This creates a dependency on a temporary branch, risking workflow failures if the branch is deleted or modified. A stable reference is generally preferred.
📊 Page Load Benchmark ResultsCurrent Commit: 📄 Localhost MetaMask Test DappSamples: 100 Summary
📈 Detailed Results
Results generated automatically by MetaMask CI |
Builds ready [7af9302]
UI Startup Metrics (1282 ± 71 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
on: | ||
push: | ||
branches: | ||
- 'Version-v*' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We no longer need to support Version-v
format.
- [Change the logo that appears when your dapp connects to MetaMask.](https://docs.metamask.io/wallet/how-to/display/icon/) | ||
|
||
[1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bmetamask-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20metamask%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BbackgroundConnection%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bmetamask-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bmetamask-inpage%5D%0A%5D%0A%0A%5Bmetamask-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bmetamask-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bmetamask-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bmetamask-contentscript%5D%0A%5Bmetamask-contentscript%5D%3C-%3E%5Bmetamask-background%5D%0A%5Bmetamask-background%5D%3C-%3E%5Bmetamask-ui%5D%0A%5Bmetamask-background%5D%3C-%3E%5Brpc%5D%0A | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably an error: these new lines are not needed
Tested here: consensys-test#204, https://github.com/consensys-test/metamask-extension-test-workflow2/actions/runs/18538077577
Ticket: https://consensyssoftware.atlassian.net/browse/INFRA-2576
Added a new workflow to update or create the changelog when release PRs are created or receive new merges.
Update Release Changelog PR (update-release-changelog.yml)
When it runs:
Triggers on every push to release branches matching:
Version-v* (e.g., Version-v13.3.0)
release/[0-9]+.[0-9]+.[0-9]+ (e.g., release/999.98.0)
What it does:
Calls the github-tools update-release-changelog.yml workflow
This workflow runs the update-release-changelog.sh script
The script uses @metamask/auto-changelog to generate/update the changelog
When CHANGELOG.md Gets Created or Updated
Initial Creation:
Branch Creation: When you create a release/999.98.0 branch
Auto Create Release PR: Triggers and calls create-release-pr.yml
Create Release PR: Calls github-tools to create the release PR
Changelog Creation: The github-tools script:
Creates a changelog branch: release/999.98.0-Changelog
Runs yarn auto-changelog update --rc --autoCategorize --useChangelogEntry --useShortPrLink
Creates/updates CHANGELOG.md with commits since the last tag
Creates a PR: release: release/999.98.0-Changelog
Subsequent Updates:
New Commits: When you push new commits to release/999.98.0
Update Release Changelog PR: Triggers automatically
Changelog Update: The workflow:
Checks out the existing release/999.98.0-Changelog branch
Runs the auto-changelog script again
Updates the existing CHANGELOG.md with new commits
Commits and pushes the changes to the existing changelog PR
The auto-changelog looks for git tags to determine the commit range
Duplicate Filtering: It filters out commits that don't have PR numbers or are already in the changelog
Description
Changelog
CHANGELOG entry:
Related issues
Fixes:
Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist
Note
Add a GitHub Actions workflow that triggers on release branches to generate/update the release changelog PR via MetaMask/github-tools.
Written by Cursor Bugbot for commit 7af9302. This will update automatically on new commits. Configure here.