plumbing: config, Branch name with hash can be cloned. Fixes #309 #354

dowy · 2021-07-24T00:41:42Z

This is a fix for #309 'Can't clone branch ref name with hash/number sign (#)'

The problem is occurring because the # character in a git config file is interpreted as a comment. In fact, the config-file writer needs to escape a number of characters that would cause it to create an invalid config-file.

Following example copied from #611

When a repository is cloned a config file is created in the .git directory. I have mocked up an example below by hand:

[core]
	bare = false # This is just a comment so is ignored
[remote "origin"]
	url = https://https://github.com/myrepo.git
	fetch = +refs/heads/release/mybranchname:refs/remotes/origin/release/mybranchname

However, if there is a # character in the branch name like this:

[core]
	bare = false # This is just a comment so is ignored
[remote "origin"]
	url = https://https://github.com/myrepo.git
	fetch = +refs/heads/release/my#branchname:refs/remotes/origin/release/my#branchname

When go-git reads back the file it ignores everything after the # character, so the value read for the fetch option, rather than looking like this:

+refs/heads/release/my#branchname:refs/remotes/origin/release/my#branchname

It is read back from the file as this:

+refs/heads/release/my

go-git then returns an error 'malformed refspec, separators are wrong' because it is expecting at least one ':' separator character in that value.

The fix is to add quotes when encoding that file, so it looks like this:

[core]
	bare = false # This is just a comment so is ignored
[remote "origin"]
	url = https://https://github.com/myrepo.git
	fetch = "+refs/heads/release/my#branchname:refs/remo
8000
tes/origin/release/my#branchname"

Then when reading and decoding that file go-git gets the correct value.

mcuadros · 2021-07-26T08:06:24Z

How does this help to the issue? Since this is only related to the config file.
Have you tested this with the example code from the original issue?

dowy · 2021-07-26T09:02:29Z

How does this help to the issue? Since this is only related to the config file.
Have you tested this with the example code from the original issue?

Yes, I have tested it.
The "PlainClone" code writes a bunch of stuff to a Config file, then reads it back wrongly, ignoring the "comment" after the hash.
I don't understand why the code does that but fixing the Config file handling fixes the problem.

dowy · 2022-05-22T09:33:16Z

@mcuadros
Are you ok to approve this?

shiqi-synctera · 2022-10-21T20:07:57Z

We are also running into this, would love if the fix can be merged in :))

plumbing: config, Branch name with hash can be cloned. Fixes #309

9acce50

dowy mentioned this pull request Jul 24, 2021

Can't clone branch ref name with hash/number sign (#) #309

Closed

Adrian Pronk added 3 commits July 24, 2021 12:54

plumbing: config, remove duplicated character in set

437ae96

plumbing: config, support correct escaping as per git-config rules

a551164

plumbing: config, fix broken unit tests

4efe4cb

erizocosmico approved these changes Nov 8, 2022

View reviewed changes

adrian-kiwibank mentioned this pull request Nov 9, 2022

Add quotes around option values with hash in git config files #611

Closed

mcuadros merged commit acd6c65 into go-git:master Nov 17, 2022

lunar-renovate mentioned this pull request Jan 27, 2023

Update go package upgrades - autoclosed lunarway/release-manager#469

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

plumbing: config, Branch name with hash can be cloned. Fixes #309 #354

plumbing: config, Branch name with hash can be cloned. Fixes #309 #354

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

plumbing: config, Branch name with hash can be cloned. Fixes #309 #354

plumbing: config, Branch name with hash can be cloned. Fixes #309 #354

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!