feat: pin/unpin git branches in Git: Checkout#319214
Open
TomasMartinsFerreira wants to merge 1 commit into
Open
feat: pin/unpin git branches in Git: Checkout#319214TomasMartinsFerreira wants to merge 1 commit into
TomasMartinsFerreira wants to merge 1 commit into
Conversation
We added a button to each branch item in the Git: Checkout interface that allows users to pin and unpin their git branches. Pinned branches appear at the top with an additional icon for visual distinction. The following commands were also created to allow for quicker pinning/unpinning (executable from the command palette): - Git: Pin Branch - Git: Unpin Branch - Git: Pin Current Branch Closes microsoft#285828 Co-authored-by: Tomás Ferreira <tomasmartinsferreira@tecnico.ulisboa.pt>
Contributor
📬 CODENOTIFYThe following users are being notified based on files changed in this PR: @lszomoruMatched files:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds the ability to pin/unpin Git branches so that they appear at the top of the branch picker for quick access. Pinned branches are persisted per-repository in globalState, exposed via three new commands, and surfaced in the existing checkout quick pick with inline pin/unpin buttons.
Changes:
- Adds
pinBranch/unpinBranch/isBranchPinnedAPIs onRepository, persisted underpinnedBranches:<root>inglobalState, and auto-unpins when a branch is deleted. - Updates the checkout quick pick to render a
PinnedCheckoutItem, group pinned branches under a "pinned" separator, and provide inline pin/unpin buttons that refresh the pick in place. - Adds three new commands (
git.pinBranch,git.unpinBranch,git.pinCurrentBranch) with corresponding NLS entries, plus tests for the pinning logic.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| extensions/git/src/repository.ts | Implements pin/unpin storage and unpins on branch deletion. |
| extensions/git/src/commands.ts | Adds pinned UI, inline buttons, separator grouping, and new commands. |
| extensions/git/package.json | Registers the three new pin-related commands. |
| extensions/git/package.nls.json | Adds command titles for pin/unpin commands. |
| extensions/git/src/test/repository.test.ts | Adds tests for branch pinning behavior. |
Comment on lines
+3398
to
+3401
| const pinnedBranches = this.getPinnedBranches(); | ||
| pinnedBranches.push(branch); | ||
|
|
||
| this.globalState.update(this.getPinnedBranchesStorageKey(), pinnedBranches); |
| const pinnedBranches = this.getPinnedBranches(); | ||
| pinnedBranches.push(branch); | ||
|
|
||
| this.globalState.update(this.getPinnedBranchesStorageKey(), pinnedBranches); |
Comment on lines
+664
to
+669
| icon: isPinned | ||
| ? 'star-full' | ||
| : 'star-empty', | ||
| label: isPinned | ||
| ? 'Unpin Branch' | ||
| : 'Pin Branch', |
Comment on lines
+706
to
+708
| return pinned.length === 0 | ||
| ? result | ||
| : [new RefItemSeparator(undefined, 'pinned'), ...pinned, ...unpinned]; |
Comment on lines
+172
to
+175
| constructor(override readonly ref: Branch, shortCommitLength: number, private readonly inner: CheckoutItem) { | ||
| super(ref, shortCommitLength); | ||
| this.inner = inner; | ||
| } |
Comment on lines
+2987
to
+2997
| disposables.push((quickPick.onDidTriggerItemButton(async (e) => { | ||
| const item = e.item as CheckoutItem; | ||
| if (button.actual && item.refName) { | ||
| button.actual.run(item.refRemote ? item.refName.substring(item.refRemote.length + 1) : item.refName); | ||
| const button = e.button as QuickInputButton & { | ||
| actual: RemoteSourceAction | PinBranchAction; | ||
| }; | ||
|
|
||
| if (!button.actual || !item.refName) { | ||
| return; | ||
| } | ||
|
|
||
| button.actual.run(item.refRemote ? item.refName.substring(item.refRemote.length + 1) : item.refName); |
Comment on lines
+50
to
+60
| function createRepository(root: string, globalState: Memento): Repository { | ||
| const repository = Object.create(Repository.prototype) as Record<string, unknown>; | ||
| repository.repository = { | ||
| root, | ||
| rootRealPath: undefined, | ||
| dotGit: undefined, | ||
| kind: 'repository' | ||
| }; | ||
| repository.globalState = globalState; | ||
| return repository as unknown as Repository; | ||
| } |
Author
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #285828
Issue
Issue #285828 requests a feature that allows users to pin and unpin branches in VS Code. This feature should also include a clear visual distinction between pinned and unpinned branches.
Solution
We added a button to each branch item in the Git: Checkout interface that allows users to pin and unpin their git branches. Pinned branches appear at the top with an additional icon for visual distinction.
The following commands were also created to allow for quicker pinning/unpinning (executable from the command palette):