gogit: Add WithSingleBranch #433
Merged
Conversation
This file contains 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
pjbgf
pushed a commit
to fluxcd/image-automation-controller
that referenced
this pull request
Dec 14, 2022
The new feature gate enables the download of all branch head references when push branches are configured. Fix fluxcd/flux2#3384. Relates to fluxcd/pkg#433. Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
stefanprodan
approved these changes
Dec 15, 2022
pjbgf
force-pushed
the
single-branch
branch
2 times, most recently
from
d8dda52
to
6928ef2
Compare
darkowlzz
approved these changes
Dec 15, 2022
git/gogit/client.go
Outdated
| return nil | ||
| refName := plumbing.NewBranchReferenceName(branchName) | ||
| _, err = g.repository.Reference(refName, true) | ||
| if err == plumbing.ErrReferenceNotFound { |
There was a problem hiding this comment.
Can use errors.Is() here and above?
git/gogit/client_test.go
Outdated
| err = createBranch(repo, "ahead") | ||
| g.Expect(err).ToNot(HaveOccurred()) | ||
|
|
||
| cc, err := commitFile(repo, "test", "testing gogit switch ahead branch", time.Now()) |
There was a problem hiding this comment.
Not that it really matters but the content of the file may not be accurate for this test case.
Same for new cases below.
aryan9600
approved these changes
Dec 16, 2022
At present go-git does not support the MULTI_ACK capability, which means that follow-up fetches on a given remote will fail. To support Image Automation Controller use cases, the SwitchBranch was initially short-circuited to avoid additional fetches. However, this has the side effect of the controller pushing the same change to the target repository multiple times. (fluxcd/flux2#3384) In order to avoid this, a new WithSingleBranch option was created to enable the download of all references at the initial clone. From now on SwitchBranch has the single responsibility of switching branches, and no longer pulling references. The package git/gogit's primary goal is to support Flux use cases, currently there is no need to expand the current API to expose ways for users to refresh repository references outside the initial clone. Signed-off-by: Paulo Gomes <paulo.gomes@weave.works>
aryan9600
added a commit
to aryan9600/pkg
that referenced
this pull request
May 12, 2023
Add `PushConfig.Force` for force pushing and remove `gogit.Client.forcePush` in favor of the former. Remove some stale test cases from `TestSwitchBranch` related to force push since we don't check if force pushing is enabled while switching branches anymore. Ref: fluxcd#433 Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
aryan9600
added a commit
that referenced
this pull request
May 15, 2023
Add `PushConfig.Force` for force pushing and remove `gogit.Client.forcePush` in favor of the former. Remove some stale test cases from `TestSwitchBranch` related to force push since we don't check if force pushing is enabled while switching branches anymore. Ref: #433 Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
aryan9600
added a commit
that referenced
this pull request
May 15, 2023
Add `PushConfig.Force` for force pushing and remove `gogit.Client.forcePush` in favor of the former. Remove some stale test cases from `TestSwitchBranch` related to force push since we don't check if force pushing is enabled while switching branches anymore. Ref: #433 Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
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.
At present go-git does not support the
MULTI_ACKcapability, which means that follow-up fetches on a given remote will fail.To support Image Automation Controller use cases, the SwitchBranch was initially short-circuited to avoid additional fetches. However, this has the side effect of the controller pushing the same change to the target repository multiple times. (fluxcd/flux2#3384)
In order to avoid this, a new
WithSingleBranchoption was created to enable the download of all references at the initial clone. From now onSwitchBranchhas the single responsibility of switching branches, and no longer pulling references.The package
git/gogit's primary goal is to support Flux use cases, currently there is no need to expand the current API to expose ways for users to refresh repository references outside the initial clone.