Fix: Prevent changelog PR creation when branches are in sync #177

jluque0101 · 2025-11-28T11:16:48Z

What is the current state of things and why does it need to change?

When a changelog PR is merged and then a new commit triggers the workflow again, the workflow attempts to create a new PR even when there are no changes between the changelog branch and the release branch. This results in the GraphQL "No commits between branches" error.

What is the solution your changes offer and how does it work?

The fix adds logic to gracefully handle the post-merge scenario:

Tracks commit status - Records whether changes were actually committed (changes_committed boolean)
Checks for diff - When commit fails (no changes), compares changelog branch vs release branch
Exits gracefully - If no diff found, returns success instead of trying to create PR
Prevents error - Avoids the GraphQL "No commits between branches" error

Result: The script now handles the post-merge scenario where both branches are identical without failing.

Testing

Tested in consensys-test/metamask-extension-test using the fix/INFRA-3167-manage-no-diff branch:

Test Scenario: "No Diff" - Branches in Sync After Merge

Step	Action	Result
1	Created `release/6000.0.0` branch	✅ Branch created
2	Workflow triggered, created changelog PR	✅ PR #45 created
3	Merged changelog PR #46 to sync branches	✅ Merged
4	Workflow #137 triggered	✅ Started
5	auto-changelog ran - no new entries	✅ No changes to CHANGELOG.md
6	Commit failed (nothing to commit)	✅ `changes_committed=false`
7	Fix kicked in: Diff check executed	✅ Compared branches
8	No diff found - branches in sync	✅ Empty diff
9	Workflow exited gracefully	✅ Succeeded in 4m 10s
10	No unnecessary PR created	✅ No new PR

Final State:

Changelog branch: 37624ba7c9 (merge commit only)
Release branch: 7b37e1923d (merged PR)
Diff: Empty ✅

Related Issues

Fixes INFRA-3167
See original failing run: https://github.com/MetaMask/metamask-extension/actions/runs/18966389348/job/54163803963?pr=37397

Copilot

Pull request overview

This PR fixes an issue where the changelog update script would fail when attempting to create a PR for branches that are already in sync (have no differences). This scenario occurs after a changelog PR has been merged, when the script runs again and finds no new changes to commit.

Key Changes:

Tracks whether changelog changes were successfully committed using a boolean flag
When no commit occurs, compares the changelog branch against the release branch to detect any differences
Returns successfully and skips PR creation if branches are in sync, preventing the "No commits between branches" GraphQL error

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-04T17:30:57Z

.github/scripts/update-release-changelog.sh

+    # Check if there are any differences between the changelog branch and release branch
+    if ! ${changes_committed}; then
+        echo "Checking for differences between ${changelog_branch} and ${release_branch}.."
+        if ! git diff --quiet "origin/${release_branch}" "HEAD"; then
+            echo "Differences found between branches; proceeding with PR creation."
+        else
+            echo "No differences between ${changelog_branch} and ${release_branch}."
+            echo "Branches are already in sync; skipping PR creation."
+            echo "Changelog workflow completed successfully (no updates needed)."
+            return 0
+        fi
+    fi


The new branch synchronization check logic (lines 177-188) lacks test coverage. Since the repository has test scripts for similar shell scripts (e.g., test-create-platform-release-pr-full.sh and test-create-platform-release-pr-functions.sh), consider adding a test file like .github/scripts/tests/test-update-release-changelog.sh that validates:

The script exits gracefully when branches are in sync (no diff)

The script proceeds with PR creation when differences exist

The changes_committed flag is properly tracked

Copilot · 2025-12-04T17:30:57Z

.github/scripts/update-release-changelog.sh

        echo "No changes detected; skipping commit."
    fi

+    # Check if there are any differences between the changelog branch and release branch


[nitpick] The comment could be more descriptive about the purpose of this check. Consider updating it to:

# If no changes were committed, check if the branches are already in sync # This handles the post-merge scenario where the changelog PR was already merged

This makes it clearer why we're performing this check only when changes_committed is false.

Suggested change

# Check if there are any differences between the changelog branch and release branch

# If no changes were committed, check if the branches are already in sync

# This handles the post-merge scenario where the changelog PR was already merged

## **Description** Updates `github-tools` to v1.1.3 across release workflows. ### Changes - Updated `create-release-pr.yml` to use `github-tools@v1.1.3` - Updated `update-release-changelog.yml` to use `github-tools@v1.1.3` ### What's included in v1.1.3 - **Fixed**: Prevent changelog PR creation when branches are in sync ([#177](MetaMask/github-tools#177)) See [github-tools v1.1.3 release notes](https://github.com/MetaMask/github-tools/releases/tag/v1.1.3). [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/38588?quickstart=1) ## **Changelog** CHANGELOG entry: null ## **Related issues** Fixes: https://consensyssoftware.atlassian.net/browse/INFRA-3167 ## **Manual testing steps** 1. This is a workflow configuration change - no manual testing required 2. Changes will be validated during the next release cycle ## **Screenshots/Recordings** N/A - workflow configuration change only ### **Before** N/A ### **After** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I've included tests if applicable - [x] I've documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I've applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

## **Description** Updates `github-tools` to v1.1.3 in release workflows. ### Changes - Updated `update-release-changelog.yml` to use `github-tools@v1.1.3` ### What's included in v1.1.3 - **Fixed**: Prevent changelog PR creation when branches are in sync ([#177](MetaMask/github-tools#177)) See [github-tools v1.1.3 release notes](https://github.com/MetaMask/github-tools/releases/tag/v1.1.3). ## **Changelog** CHANGELOG entry: null ## **Related issues** Fixes: https://consensyssoftware.atlassian.net/browse/INFRA-3167 ## **Manual testing steps** ```gherkin Feature: Release changelog workflow Scenario: Workflow uses updated github-tools version Given the workflow configuration is updated When a release branch receives a push Then the workflow uses github-tools v1.1.3 ``` ## **Screenshots/Recordings** N/A - workflow configuration change only ### **Before** N/A ### **After** N/A ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I've included tests if applicable - [x] I've documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I've applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Qbandev requested a review from Copilot November 28, 2025 12:03

Copilot started reviewing on behalf of Qbandev November 28, 2025 12:04 View session

Copilot finished reviewing on behalf of Qbandev November 28, 2025 12:06

Copilot AI reviewed Nov 28, 2025

View reviewed changes

gauthierpetetin previously approved these changes Nov 28, 2025

View reviewed changes

Fix: Prevent changelog PR creation when branches are in sync

336efef

Qbandev force-pushed the fix/INFRA-3167-manage-no-diff branch from 5fbc261 to 336efef Compare December 4, 2025 14:50

chore: run prettier

4c76fde

Qbandev dismissed gauthierpetetin’s stale review via 4c76fde December 4, 2025 17:10

fix: update CHANGELOG.md links for v1.1.2

4bb0191

Qbandev requested review from Copilot and gauthierpetetin December 4, 2025 17:26

Copilot started reviewing on behalf of Qbandev December 4, 2025 17:27 View session

bsgrigorov approved these changes Dec 4, 2025

View reviewed changes

Copilot finished reviewing on behalf of Qbandev December 4, 2025 17:29

Copilot AI reviewed Dec 4, 2025

View reviewed changes

Qbandev merged commit 82f1952 into main Dec 4, 2025
26 checks passed

Qbandev deleted the fix/INFRA-3167-manage-no-diff branch December 4, 2025 22:05

This was referenced Dec 5, 2025

chore: update github-tools to v1.1.3 MetaMask/metamask-extension#38588

Merged

chore: update github-tools to v1.1.3 MetaMask/metamask-mobile#23710

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix: Prevent changelog PR creation when branches are in sync #177

Fix: Prevent changelog PR creation when branches are in sync #177

Uh oh!

jluque0101 commented Nov 28, 2025 •

edited by Qbandev

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Copilot AI Dec 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	# Check if there are any differences between the changelog branch and release branch
	# If no changes were committed, check if the branches are already in sync
	# This handles the post-merge scenario where the changelog PR was already merged

Uh oh!

Fix: Prevent changelog PR creation when branches are in sync #177

Fix: Prevent changelog PR creation when branches are in sync #177

Uh oh!

Conversation

jluque0101 commented Nov 28, 2025 • edited by Qbandev Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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?

Testing

Test Scenario: "No Diff" - Branches in Sync After Merge

Related Issues

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jluque0101 commented Nov 28, 2025 •

edited by Qbandev

Loading