INFRA-3041: Stable sync workflow fixes by XxdpavelxX · Pull Request #154 · MetaMask/github-tools

XxdpavelxX · 2025-10-29T15:34:43Z

Ticket: https://consensyssoftware.atlassian.net/browse/INFRA-3041

Summary of Changes

Prevented github-tools from appearing in PRs
File: github-tools/.github/workflows/stable-sync.yml
What: Added explicit cleanup commands to unstage and remove github-tools directory before pushing
Impact: The sync PR will no longer include a github-tools/ submodule or directory
Disabled package.json version bump for Extension
File: github-tools/.github/scripts/stable-sync.js
What: Removed the yarn version logic that bumped package.json version
Before: Extension ran yarn version to update the version
After: Extension now preserves package.json from stable branch (same as mobile)
Impact: No version bump will occur in the sync PR for either mobile or extension
Verified PR title format
File: github-tools/.github/workflows/stable-sync.yml (line 147)
What: Confirmed it already uses release: prefix (no change needed)
Format: "release: sync stable to main for version X.Y.Z"

Testing in Extension: consensys-test/metamask-extension-test-workflow2#209, https://github.com/consensys-test/metamask-extension-test-workflow2/actions/runs/18951817173
Testing in Mobile: consensys-test/metamask-mobile-test-workflow#30, https://github.com/consensys-test/metamask-mobile-test-workflow/actions/runs/18951842114

Testing Post CR comments: consensys-test/metamask-extension-test-workflow2#212

Note

Stabilizes the sync process by ignoring github-tools in PRs, removing the extension version bump, and force-pushing existing stable sync branches.

Workflows:
- stable-sync.yml:
  - Add guard to append github-tools/ to .gitignore to prevent committing it.
  - Change push behavior: force-push when stable-main-<version> branch exists; set upstream on first push.
Scripts:
- github-tools/.github/scripts/stable-sync.js:
  - Remove extension-specific package.json version bump; only run mobile-specific file checkouts.
  - Default non-mobile repos to no repo-specific commands.

^{Written by Cursor Bugbot for commit ee74d68. This will update automatically on new commits. Configure here.}

Signed-off-by: Pavel Dvorkin <pavel.dvorkin@consensys.net>

gauthierpetetin

Thanks for the PR, I added a few comments.

gauthierpetetin · 2025-10-31T10:10:14Z

+
+      // Preserve package.json from stable branch (no version bump)
+      await exec(`git checkout origin/${baseBranch} -- package.json`);
+      console.log(`Executed: git checkout origin/${baseBranch} -- package.json`);


We don't need to preserve package.json from stable branch. We can delete this line which will leave us without extension-specific commands.

For reference, we want to reproduce the logic that's currently in stable-sync-legacy.js script, i.e. create a stable-sync branch that will be merged into main while:

Bringing commit history from stable (the cherry-picked commits) into main

Bringing CHANGELOG.md updates from stable into main

Avoiding code conflicts because the code changes are already in main (they were cherry-picked to create the release)

Ok, I was under the impression we wanted to preserve it. Will remove the extra logic here. Thanks

gauthierpetetin · 2025-10-31T10:22:33Z

+            git config submodule.recurse false
+            git config diff.ignoreSubmodules all
+
+            # Start the rebase


I wonder whether we really need a rebase. Can we not just override the origin/stable-main-${{ inputs.semver-version }} branch with a git push force?

gauthierpetetin · 2025-10-31T10:25:25Z

          # Check if branch exists remotely
          echo "Cleaning up github-tools"
          rm -rf github-tools
+          # Ensure github-tools is not staged or tracked


I wonder where the github-tools file comes from. Maybe instead of introducing all this logic to avoid including it in the commit, we could just add it to .gitignore?

cursor · 2025-11-04T21:36:45Z

+            echo "github-tools/" >> .gitignore
+            echo "Added github-tools/ to .gitignore"
+          fi
+


Bug: Gitignore Overwritten by Git Commands Reinstating Exclusions

The workflow adds github-tools/ to .gitignore to prevent its commitment. However, the stable-sync.js script's git commands restore files from origin/main, overwriting .gitignore and undoing the exclusion. This means github-tools/ may still be committed.

@XxdpavelxX is this a valid comment?

No I don't think it's relevant. We're adding github-tools/ to .gitignore in mobile, extension also so it shouldn't be an issue once we do that.

## **Description** Ticket: https://consensyssoftware.atlassian.net/browse/INFRA-3041 Github-tools PR: MetaMask/github-tools#154 Summary of Changes Prevented github-tools from appearing in PRs File: github-tools/.github/workflows/stable-sync.yml What: Added explicit cleanup commands to unstage and remove github-tools directory before pushing Impact: The sync PR will no longer include a github-tools/ submodule or directory Disabled package.json version bump for Extension File: github-tools/.github/scripts/stable-sync.js What: Removed the yarn version logic that bumped package.json version Before: Extension ran yarn version to update the version After: Extension now preserves package.json from stable branch (same as mobile) Impact: No version bump will occur in the sync PR for either mobile or extension Verified PR title format File: github-tools/.github/workflows/stable-sync.yml (line 147) What: Confirmed it already uses release: prefix (no change needed) Format: "release: sync stable to main for version X.Y.Z" Testing in Extension: consensys-test#209, https://github.com/consensys-test/metamask-extension-test-workflow2/actions/runs/18951817173 Testing in Mobile: consensys-test/metamask-mobile-test-workflow#30, https://github.com/consensys-test/metamask-mobile-test-workflow/actions/runs/18951842114 Testing Post CR comments: consensys-test#212 ## **Changelog**  CHANGELOG entry: None ## **Related issues** Fixes: ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] 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). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] 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.  --- > [!NOTE] > Bumps stable-branch sync workflow to a new github-tools ref and ignores the `github-tools/` directory. > > - **CI/Workflows**: > - Update `.github/workflows/stable-branch-sync.yml` to use `metamask/github-tools/.github/workflows/stable-sync.yml@79ce6e3` and set `github-tools-version` to `79ce6e3`. > - **Repo hygiene**: > - Add `github-tools/` to `.gitignore`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit f8418e5. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

## **Description** Ticket: https://consensyssoftware.atlassian.net/browse/INFRA-3041 Github-tools PR: MetaMask/github-tools#154, MetaMask/github-tools#160 Changelog PR before updates: consensys-test#31 Changelog PR after updates: consensys-test#37 Summary of Changes Prevented github-tools from appearing in PRs File: github-tools/.github/workflows/stable-sync.yml What: Added explicit cleanup commands to unstage and remove github-tools directory before pushing Impact: The sync PR will no longer include a github-tools/ submodule or directory Disabled package.json version bump for Extension File: github-tools/.github/scripts/stable-sync.js What: Removed the yarn version logic that bumped package.json version Before: Extension ran yarn version to update the version After: Extension now preserves package.json from stable branch (same as mobile) Impact: No version bump will occur in the sync PR for either mobile or extension Verified PR title format File: github-tools/.github/workflows/stable-sync.yml (line 147) What: Confirmed it already uses release: prefix (no change needed) Format: "release: sync stable to main for version X.Y.Z" Testing in Extension: consensys-test/metamask-extension-test-workflow2#209, https://github.com/consensys-test/metamask-extension-test-workflow2/actions/runs/18951817173 Testing in Mobile: consensys-test#30, https://github.com/consensys-test/metamask-mobile-test-workflow/actions/runs/18951842114 Testing Post CR comments: consensys-test/metamask-extension-test-workflow2#212 ## **Changelog**  CHANGELOG entry: None ## **Related issues** Fixes: ## **Manual testing steps** ```gherkin Feature: my feature name Scenario: user [verb for user action] Given [describe expected initial app state] When user [verb for user action] Then [describe expected outcome] ``` ## **Screenshots/Recordings**  ### **Before**  ### **After**  ## **Pre-merge author checklist** - [ ] 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). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] 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.  --- > [!NOTE] > Updates the stable branch sync workflow to use metamask/github-tools commit 701a894 for both the reusable workflow and the input version. > > - **CI/Workflows**: > - Update `uses` in `.github/workflows/stable-branch-sync.yml` to `metamask/github-tools/.github/workflows/stable-sync.yml@701a894f38883ab48560f948e98b76cc6b4d623f`. > - Set `github-tools-version` input to `701a894f38883ab48560f948e98b76cc6b4d623f`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 77f5118. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>

INFRA-3041: Stable sync workflow fixes

cb7d8e7

metamaskbot added the team-dev-ops label Oct 29, 2025

This comment was marked as outdated.

Sign in to view

XxdpavelxX added 4 commits October 29, 2025 14:46

Use github-token again as env var

0aeb5cd

Testing a fix

b915d03

Return github_token

4561116

INFRA-3041: Stable Branch sync workflow updates

d7d281c

Signed-off-by: Pavel Dvorkin <pavel.dvorkin@consensys.net>

XxdpavelxX self-assigned this Oct 30, 2025

XxdpavelxX requested a review from gauthierpetetin October 30, 2025 16:00

XxdpavelxX added 2 commits October 30, 2025 13:48

Fix: Handle github-tools cleanup during rebase and disable version bump

a54caf5

Fix: Handle submodule conflicts during rebase

b575fcf

This comment was marked as outdated.

Sign in to view

gauthierpetetin reviewed Oct 31, 2025

View reviewed changes

XxdpavelxX added 2 commits October 31, 2025 14:13

Code review fixes

ca9bd06

Linting fix

ee74d68

XxdpavelxX requested a review from gauthierpetetin November 4, 2025 21:34

cursor Bot reviewed Nov 4, 2025

View reviewed changes

gauthierpetetin approved these changes Nov 5, 2025

View reviewed changes

XxdpavelxX merged commit 79ce6e3 into main Nov 5, 2025
19 checks passed

XxdpavelxX deleted the INFRA-3041-StableBranchSync branch November 5, 2025 15:13

This was referenced Nov 5, 2025

chore: INFRA-3041-Added github-tools to .gitignore MetaMask/metamask-extension#37436

Merged

chore(INFRA-3041): Stable Sync workflow update github-tools MetaMask/metamask-mobile#22197

Merged

XxdpavelxX restored the INFRA-3041-StableBranchSync branch November 5, 2025 20:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

INFRA-3041: Stable sync workflow fixes#154

INFRA-3041: Stable sync workflow fixes#154
XxdpavelxX merged 9 commits into
mainfrom
INFRA-3041-StableBranchSync

XxdpavelxX commented Oct 29, 2025 •

edited by cursor Bot

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

gauthierpetetin left a comment

Uh oh!

gauthierpetetin Oct 31, 2025

Uh oh!

XxdpavelxX Oct 31, 2025

Uh oh!

gauthierpetetin Oct 31, 2025

Uh oh!

XxdpavelxX Oct 31, 2025

Uh oh!

gauthierpetetin Oct 31, 2025

Uh oh!

cursor Bot Nov 4, 2025

Uh oh!

gauthierpetetin Nov 5, 2025

Uh oh!

XxdpavelxX Nov 5, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

XxdpavelxX commented Oct 29, 2025 • edited by cursor Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

gauthierpetetin left a comment

Choose a reason for hiding this comment

Uh oh!

gauthierpetetin Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

XxdpavelxX Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

gauthierpetetin Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

XxdpavelxX Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

gauthierpetetin Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

cursor Bot Nov 4, 2025

Choose a reason for hiding this comment

Bug: Gitignore Overwritten by Git Commands Reinstating Exclusions

Uh oh!

gauthierpetetin Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

XxdpavelxX Nov 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

XxdpavelxX commented Oct 29, 2025 •

edited by cursor Bot

Loading

XxdpavelxX Nov 5, 2025 •

edited

Loading