Skip to content

git: add rebase to branch context menu in graph view#280111

Open
reena96 wants to merge 2 commits intomicrosoft:mainfrom
reena96:rebaseWithRightClick
Open

git: add rebase to branch context menu in graph view#280111
reena96 wants to merge 2 commits intomicrosoft:mainfrom
reena96:rebaseWithRightClick

Conversation

@reena96
Copy link
Copy Markdown

@reena96 reena96 commented Nov 29, 2025

Adds "Rebase onto Branch" option to the right-click context menu when clicking on a branch reference in the Git Graph pane.

Fixes #276712

Problem

Currently, when right-clicking on a branch in the Git Graph view, users can checkout or delete the branch, but there's no option to rebase onto it. Users who want to rebase must use the Command Palette (Git: Rebase Branch...) or the terminal.

Solution

Add a "Rebase onto Branch" context menu item that appears when right-clicking on local or remote branches in the Git Graph.

Before

  • Right-click on branch → Checkout, Delete Branch (no rebase option)

After

  • Right-click on branch → Checkout, Rebase onto Branch, Delete Branch

Key Benefits

  • Faster workflow: Rebase directly from the graph without switching to Command Palette
  • Consistent UX: Follows the same pattern as other graph context menu commands
  • Discoverable: Users can find the rebase option where they expect it

Implementation Details

Changes Made

File Change
extensions/git/package.json Add command definition, menu registration, hide from command palette
extensions/git/package.nls.json Add localization string
extensions/git/src/commands.ts Add graphRebase command handler

How It Works

  1. User right-clicks on a branch label in Git Graph
  2. "Rebase onto Branch" menu item appears (for local/remote branches only, not tags)
  3. Clicking it calls the existing repository.rebase() method with the branch name
  4. Existing rebase UI (conflict resolution, continue/abort) handles the rest

Menu Visibility

The menu item appears for:

  • ✅ Local branches (refs/heads/*)
  • ✅ Remote branches (refs/remotes/*)
  • ❌ Tags (excluded via when clause)

Testing Instructions

  1. Open a Git repository in VS Code
  2. Open Source Control view → click Graph icon
  3. Right-click on a local branch label
  4. Verify "Rebase onto Branch" appears in menu
  5. Right-click on a remote branch (e.g., origin/main)
  6. Verify "Rebase onto Branch" appears
  7. Right-click on a tag
  8. Verify "Rebase onto Branch" does NOT appear
  9. Click "Rebase onto Branch" on a branch
  10. Verify current branch rebases onto selected branch
  11. Open Command Palette → verify git.graph.rebase does NOT appear

Validation

  • TypeScript compiles with 0 errors
  • ESLint passes
  • JSON syntax validated
  • Follows existing git.graph.* command patterns
  • Manual testing completed

Performance Impact

Minimal - the command is a thin wrapper around the existing repository.rebase() method.

Reena and others added 2 commits November 28, 2025 18:56
Adds "Rebase onto Branch" option to the right-click context menu
when clicking on a branch reference in the Git Graph pane.

Fixes microsoft#276712

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Register _dropdownAction and _cancelAction with this._register() to ensure
proper disposal when the toolbar is disposed.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings November 29, 2025 23:37
@vs-code-engineering
Copy link
Copy Markdown
Contributor

📬 CODENOTIFY

The following users are being notified based on files changed in this PR:

@lszomoru

Matched files:

  • extensions/git/package.json
  • extensions/git/package.nls.json
  • extensions/git/src/commands.ts
  • src/vs/workbench/contrib/scm/browser/scmViewPane.ts

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a "Rebase onto Branch" command to the Git Graph's branch context menu, allowing users to rebase directly from the graph UI without using the Command Palette. The implementation follows established patterns for git.graph.* commands by creating a new command handler that wraps the existing repository.rebase() method.

Key changes:

  • Add git.graph.rebase command with appropriate menu integration and visibility controls
  • Register the command in the SCM history item ref context menu for local and remote branches (excluding tags)
  • Include proper localization and command palette hiding

Reviewed changes

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

File Description
extensions/git/src/commands.ts Adds graphRebase command handler that calls repository.rebase() with the selected branch name
extensions/git/package.json Registers the command, adds menu contribution to scm/historyItemRef/context, and hides from command palette
extensions/git/package.nls.json Adds localized display string "Rebase onto Branch"
src/vs/workbench/contrib/scm/browser/scmViewPane.ts Unrelated fix: wraps Action instances with this._register() to prevent memory leaks (should be in separate PR)

Comment on lines +1489 to +1498
this._dropdownAction = this._register(new Action(
'scmInputMoreActions',
localize('scmInputMoreActions', "More Actions..."),
'codicon-chevron-down');
'codicon-chevron-down'));

this._cancelAction = new MenuItemAction({
this._cancelAction = this._register(new MenuItemAction({
id: SCMInputWidgetCommandId.CancelAction,
title: localize('scmInputCancelAction', "Cancel"),
icon: Codicon.stopCircle,
}, undefined, undefined, undefined, undefined, contextKeyService, commandService);
}, undefined, undefined, undefined, undefined, contextKeyService, commandService));
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] These changes to register Actions for proper disposal are good and fix potential memory leaks. However, they appear unrelated to the PR's stated purpose of adding git graph rebase functionality. Consider moving these SCM toolbar fixes to a separate PR for better change tracking and easier code review.

Copilot uses AI. Check for mistakes.
if (!historyItemRef?.name) {
return;
}

Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding validation to prevent rebasing onto the current branch, similar to how git.graph.deleteBranch prevents deleting the active branch (lines 3073-3076). Without this check, attempting to rebase onto the current branch will fail at the git level without a user-friendly error message. Suggested addition:

if (historyItemRef.id === repository.historyProvider.currentHistoryItemRef?.id) {
    window.showInformationMessage(l10n.t('Cannot rebase onto the current branch.'));
    return;
}
Suggested change
// Prevent rebasing onto the current branch
if (historyItemRef.id === repository.historyProvider.currentHistoryItemRef?.id) {
window.showInformationMessage(l10n.t('Cannot rebase onto the current branch.'));
return;
}

Copilot uses AI. Check for mistakes.
}

@command('git.graph.rebase', { repository: true })
async graphRebase(repository: Repository, historyItem?: SourceControlHistoryItem, historyItemRefId?: string): Promise<void> {
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The method name graphRebase doesn't follow the established naming convention for git.graph.* commands. Other graph commands use numbered suffixes (e.g., checkout2, deleteBranch2, cherryPick2). Consider renaming this method to rebase2 to maintain consistency with existing patterns.

Suggested change
async graphRebase(repository: Repository, historyItem?: SourceControlHistoryItem, historyItemRefId?: string): Promise<void> {
async rebase2(repository: Repository, historyItem?: SourceControlHistoryItem, historyItemRefId?: string): Promise<void> {

Copilot uses AI. Check for mistakes.
@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

@reena96 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Git - Rebase onto a branch using right-click on a branch in GRAPH pane

3 participants