-
Notifications
You must be signed in to change notification settings - Fork 27.2k
checkout: add remoteBranchTemplate config for DWIM branch names #2136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
Welcome to GitGitGadgetHi @pasteley, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests. Please make sure that either:
You can CC potential reviewers by adding a footer to the PR description with the following syntax: NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:
It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code. Contributing the patchesBefore you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form Both the person who commented An alternative is the channel Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment If you want to see what email(s) would be sent for a After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail). If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the curl -g --user "<EMailAddress>:<Password>" \
--url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txtTo iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description): To send a new iteration, just add another PR comment with the contents: Need help?New contributors who want advice are encouraged to join [email protected], where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join. You may also be able to find help in real time in the developer IRC channel, |
c337546 to
49170e9
Compare
|
/allow |
|
User pasteley is now allowed to use GitGitGadget. WARNING: pasteley has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use. |
66286fa to
48d8872
Compare
|
/preview |
|
Error: Could not determine full name of pasteley |
|
/preview |
|
Preview email sent as [email protected] |
48d8872 to
2772529
Compare
Add checkout.remoteBranchTemplate to apply a template pattern when searching for remote branches during checkout DWIM and when creating remote branches with push.autoSetupRemote. Template uses printf-style placeholders (%s for branch name). For example, with "feature/%s", checking out "foo" searches for "origin/feature/foo" and creates local "foo" tracking it. Pushing with autoSetupRemote creates "origin/feature/bar" from local "bar". Useful when remote branches use prefixes but local branches don't. Works with git-checkout, git-worktree --guess-remote, and git-push. Signed-off-by: pasteley <[email protected]>
2772529 to
0ff8ebc
Compare
|
/submit |
|
Submitted as [email protected] To fetch this version into To fetch this version to local tag |
|
On the Git mailing list, Junio C Hamano wrote (reply to this): "Pasteley Absurda via GitGitGadget" <[email protected]> writes:
> From: pasteley <[email protected]>
>
> Add checkout.remoteBranchTemplate to apply a template pattern when
> searching for remote branches during checkout DWIM and when creating
> remote branches with push.autoSetupRemote.
>
> Template uses printf-style placeholders (%s for branch name). For
> example, with "feature/%s", checking out "foo"
> searches for "origin/feature/foo" and creates local "foo"
> tracking it. Pushing with autoSetupRemote creates "origin/feature/bar"
> from local "bar".
>
> Useful when remote branches use prefixes but local branches don't.
It fells that this is presented backwards. The usefulness of the
layout that names local branches deliberately differently from their
remote counterparts needs to be justified first. Only after that,
we can consider adding extra mechanism to support such a layout.
Once "git checkout foo" is taught to do the same as "git checkout -b
extra-foo -t origin/foo", it would create
[branch "extra-foo"]
remote = origin
merge = refs/heads/foo
but the push side would need extra work, and that is why you needed
to muck with the push refspec. But then what should happen when the
user is using "we do not bother remembering what branches to push
there; the remote repository remembers that for us", aka "matching
push"?
Most of the problems is what you are creating by using an unusual
layout to name local branches differently from the remote
counterpart. You do not have to, and then all the problems you
created with that layout goes away, without this patch.
So, I am not sure if this is a good idea to begin with. At least, I
am not yet convinced.
Thanks.
|
|
On the Git mailing list, pasteley wrote (reply to this): You're right that same-named branches are the ideal Git workflow, and I
agree this patch should not encourage drifting away from that model.
The motivation here is for cases where the name mismatch is imposed by
external constraints, not chosen by developers. For example:
1. Server-side policies/hooks that require a namespace on the remote
(e.g. `team/*`, `users/<id>/*`, `release/*`).
2. Hosting / mirroring setups where remote branches live under a fixed
prefix for organizational or access-control reasons.
3. Migrations where the remote branch layout is constrained by the
target system, while local developer workflows assume short names.
In these scenarios developers do not create the problem, they inherit it.
The alternative today is to type the prefixed remote name everywhere and
give up DWIM convenience (e.g. `git checkout foo` no longer does the
"natural" thing).
This remains opt-in via `checkout.remoteBranchTemplate`, so only workflows
that explicitly configure it change behavior; defaults stay unchanged.
Explicit operations still bypass the template (e.g. `-b/-c <name>` and an
explicit push refspec keep full user control).
Git already supports name mismatches in a few places:
* `remote.<name>.fetch` allows arbitrary mappings for remote refs.
* `branch.<name>.merge` can track a differently named remote branch.
* `push.default=upstream` pushes to the configured upstream even if names
differ.
However, configuring `remote.<name>.push` does not solve the DWIM checkout
problem: users still need to know the full remote branch name to check it
out, and wildcard push refspecs can have surprising scope (they can match
many branches unless the user is always explicit). This patch keeps the
scope narrow: it only affects cases where Git is already "guessing" the
remote side (checkout/switch/worktree --guess-remote, and automatic
upstream setup).
> Once "git checkout foo" is taught to do the same as "git checkout -b
> extra-foo -t origin/foo", it would create:
>
> [branch "extra-foo"]
> remote = origin
> merge = refs/heads/foo
Yes, but only for the DWIM path where Git derives the remote branch. When
the user explicitly names the local branch, we do not apply the template.
> But then what should happen when the user is using "matching push"?
While `push.default=matching` has been deprecated since Git 2.0 (~ 2014),
we still can handle this corner case by detecting the incompatibility
and providing a clear error message.
Thanks for the thorough review,
pasteley
On 22/12/2025 5:40 AM, Junio C Hamano wrote:
> "Pasteley Absurda via GitGitGadget" <[email protected]> writes:
>
>> From: pasteley <[email protected]>
>>
>> Add checkout.remoteBranchTemplate to apply a template pattern when
>> searching for remote branches during checkout DWIM and when creating
>> remote branches with push.autoSetupRemote.
>>
>> Template uses printf-style placeholders (%s for branch name). For
>> example, with "feature/%s", checking out "foo"
>> searches for "origin/feature/foo" and creates local "foo"
>> tracking it. Pushing with autoSetupRemote creates "origin/feature/bar"
>> from local "bar".
>>
>> Useful when remote branches use prefixes but local branches don't.
> It fells that this is presented backwards. The usefulness of the
> layout that names local branches deliberately differently from their
> remote counterparts needs to be justified first. Only after that,
> we can consider adding extra mechanism to support such a layout.
>
>
> Once "git checkout foo" is taught to do the same as "git checkout -b
> extra-foo -t origin/foo", it would create
>
> [branch "extra-foo"]
> remote = origin
> merge = refs/heads/foo
>
> but the push side would need extra work, and that is why you needed
> to muck with the push refspec. But then what should happen when the
> user is using "we do not bother remembering what branches to push
> there; the remote repository remembers that for us", aka "matching
> push"?
>
> Most of the problems is what you are creating by using an unusual
> layout to name local branches differently from the remote
> counterpart. You do not have to, and then all the problems you
> created with that layout goes away, without this patch.
>
> So, I am not sure if this is a good idea to begin with. At least, I
> am not yet convinced.
>
> Thanks.
> |
|
On the Git mailing list, Junio C Hamano wrote (reply to this): pasteley <[email protected]> writes:
> 1. Server-side policies/hooks that require a namespace on the remote
> (e.g. `team/*`, `users/<id>/*`, `release/*`).
> 2. Hosting / mirroring setups where remote branches live under a fixed
> prefix for organizational or access-control reasons.
> 3. Migrations where the remote branch layout is constrained by the
> target system, while local developer workflows assume short names.
>
> In these scenarios developers do not create the problem, they inherit it.
Nobody stops you from interacting with projects like the above, and
locally name branches you store your work in users/pasteley/topic-1
instead of topic-1, no?
> While `push.default=matching` has been deprecated since Git 2.0 (~ 2014),
> we still can handle this corner case by detecting the incompatibility
> and providing a clear error message.
I do not know if you are confused, or if you are citing somebody
else's description that is confused, but the word "deprecated" in
the above statement is misused. So is "corner case".
When we talk about deprecation, the deprecated feature is something
that is not useful for anybody to adopt because there are better
alternatives available, we wish there is no need to support the
users, and we hope we can remove it eventually someday. The
matching push does not fall into that category at all.
What we did in Git 2.0 was to change the default from matching to
simple, because the matching is the most useful for those who
publish their changes, and for those who are merely participating
somebody else's project, it is not suited. The matching push is
also harder to use properly if a project has multiple people who
push to a single repository (i.e., central repository approach).
The default was switched to make life easier for more people. It
did not diminish the usefulness of the matching mode for the
developers for whom the matching was the most useful mode. |
|
On the Git mailing list, pasteley wrote (reply to this): On 23/12/2025 1:51 AM, Junio C Hamano wrote:
> pasteley <[email protected]> writes:
> >> 1. Server-side policies/hooks that require a namespace on the remote
>> (e.g. `team/*`, `users/<id>/*`, `release/*`).
>> 2. Hosting / mirroring setups where remote branches live under a fixed
>> prefix for organizational or access-control reasons.
>> 3. Migrations where the remote branch layout is constrained by the
>> target system, while local developer workflows assume short names.
>>
>> In these scenarios developers do not create the problem, they inherit it.
> > Nobody stops you from interacting with projects like the above, and
> locally name branches you store your work in users/pasteley/topic-1
> instead of topic-1, no?
> I would say: forced to handle it this way. And guessing I’m not the only
one struggling. Meanwhile, there’s a simple quality-of-life improvement
that would help avoid all the hacky custom aliases and shell workarounds
for what should be a relatively straightforward remote refspec format
adjustment.
I’d really like to see this discussion move toward practical,
constructive steps, though I’m not sure what it would take to get there. |
No description provided.