From 17aea1a9cc0cdeb5985492c942f44026a9a49d0c Mon Sep 17 00:00:00 2001 From: Salah-Eddine Saakoun Date: Wed, 2 Sep 2026 15:40:21 +0200 Subject: [PATCH 1/2] ci: run update-changelogs on comment for non-release PRs --- .github/workflows/update-changelogs.yml | 4 ++-- docs/processes/updating-changelogs.md | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/.github/workflows/update-changelogs.yml b/.github/workflows/update-changelogs.yml index d81c8dd7c92..1c88bb578ca 100644 --- a/.github/workflows/update-changelogs.yml +++ b/.github/workflows/update-changelogs.yml @@ -92,7 +92,7 @@ jobs: react-to-comment: name: React to the comment needs: is-release - if: needs.is-release.outputs.is-release == 'true' && github.event_name == 'issue_comment' + if: github.event_name == 'issue_comment' runs-on: ubuntu-latest environment: default-branch permissions: @@ -123,7 +123,7 @@ jobs: update-changelogs: name: Update changelogs needs: is-release - if: ${{ needs.is-release.outputs.is-release == 'true' }} + if: needs.is-release.outputs.is-release == 'true' || github.event_name == 'issue_comment' runs-on: ubuntu-latest environment: default-branch permissions: diff --git a/docs/processes/updating-changelogs.md b/docs/processes/updating-changelogs.md index 4d01939d22d..ebebde70c86 100644 --- a/docs/processes/updating-changelogs.md +++ b/docs/processes/updating-changelogs.md @@ -16,3 +16,17 @@ We will offer more guidance here in the future, but in general: - Combine like changes from multiple pull requests into a single changelog entry if necessary. - Split disparate changes from the same pull request into multiple entries if necessary. - Omit reverted changes from the changelog. + +## Updating changelogs automatically + +Some changelog entries are mechanical, such as the entries that record dependency bumps across packages. You can get these written for you instead of writing them by hand: + +1. Post a comment on your pull request with the text `@metamaskbot update-changelogs`. +2. The `Update Changelogs` GitHub action reacts to your comment with a 👍 and kicks off. +3. After a few minutes you will see a new comment saying either that the changelogs were updated and pushed to your branch, or that no changes were needed. If validation errors remain that the action cannot fix, the comment links to the workflow run so you can see them. + +A few things to know: + +- This works on any pull request, not just release pull requests. Release pull requests also get this automatically when they are opened. +- If the action pushes a commit, remember to pull it before you push again. +- This only works on pull requests opened from a branch in this repo. Pull requests from forks are skipped, so if you are an outside contributor you will need to update changelogs by hand. From d1d87058f7c81e5cdd01c3f60c40c880f37680bc Mon Sep 17 00:00:00 2001 From: Salah-Eddine Saakoun Date: Wed, 2 Sep 2026 20:28:12 +0200 Subject: [PATCH 2/2] Apply review suggestions --- docs/processes/updating-changelogs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/processes/updating-changelogs.md b/docs/processes/updating-changelogs.md index ebebde70c86..f5b3b6fb2f8 100644 --- a/docs/processes/updating-changelogs.md +++ b/docs/processes/updating-changelogs.md @@ -17,9 +17,9 @@ We will offer more guidance here in the future, but in general: - Split disparate changes from the same pull request into multiple entries if necessary. - Omit reverted changes from the changelog. -## Updating changelogs automatically +## Generating changelog entries for dependency bumps -Some changelog entries are mechanical, such as the entries that record dependency bumps across packages. You can get these written for you instead of writing them by hand: +Recording dependency bumps within package changelogs can be tedious. You can have these entries generated for you instead of writing them by hand: 1. Post a comment on your pull request with the text `@metamaskbot update-changelogs`. 2. The `Update Changelogs` GitHub action reacts to your comment with a 👍 and kicks off. @@ -28,5 +28,5 @@ Some changelog entries are mechanical, such as the entries that record dependenc A few things to know: - This works on any pull request, not just release pull requests. Release pull requests also get this automatically when they are opened. -- If the action pushes a commit, remember to pull it before you push again. +- If the action pushes a commit to your branch, remember to pull it locally before you push again. - This only works on pull requests opened from a branch in this repo. Pull requests from forks are skipped, so if you are an outside contributor you will need to update changelogs by hand.