Add support for Git submodules with go-git #327
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
stefanprodan
added
enhancement
squaremo
reviewed
Mar 29, 2021
stefanprodan
force-pushed
the
fetch-submodules
branch
2 times, most recently
from
7386b7d
to
19cf29e
Compare
hiddeco
approved these changes
Mar 29, 2021
stefanprodan
force-pushed
the
fetch-submodules
branch
2 times, most recently
from
d3a9679
to
46343a8
Compare
squaremo
reviewed
Mar 30, 2021
Wouldn't that be testing go-git cloning that's covered in go-git? Any hits how to write this test or how to make our Git server serve submodules? For referece, I do test my PRs on real clusters: Without submodules: With submodules: |
[and]
I believe you. But did you test in advance all future changes to the code to make sure they didn't e.g., accidentally invert, or omit, the argument that is given to go-git? ;-)
I don't think you need to do anything special to the git server for submodules to work, other than serve more than one repo -- they are a client-side feature. There's already a bunch of scaffolding for creating a git server and getting stuff from it in gitrepository_controller_test.go, this won't be much of a stretch beyond that will it? |
I see no files being pushed to Git, can you give some hints how to setup submodules, I'm lost. |
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
stefanprodan
force-pushed
the
fetch-submodules
branch
from
46343a8
to
664a568
Compare
These lines init a git repo, create a file, commit it, and push to the test server: https://github.com/fluxcd/source-controller/blob/main/controllers/gitrepository_controller_test.go#L120-L156 If you prefer getting the files from testdata/, here's the equivalent from image-automation, that walks the filesystem and adds files from there: https://github.com/fluxcd/image-automation-controller/blob/main/controllers/update_test.go#L860 As for submodules: I haven't created submodules using go-git. It looks like go-git understands submodules (https://github.com/go-git/go-git/blob/master/_examples/submodule/main.go), but I'm not sure if it will create them. Might take a bit of fishing around in the go-git docs. |
squaremo
force-pushed
the
fetch-submodules
branch
2 times, most recently
from
225ecf5
to
2ef4c22
Compare
stefanprodan
commented
Mar 31, 2021
This commit adds a test specifically for RecurseSubmodules. It takes a bit more preparation, since it needs a repo using submodules to start with. go-git doesn't appear to support adding submodules programmatically, so the preparation is done in part by execing `git`. Signed-off-by: Michael Bridgen <michael@weave.works>
squaremo
force-pushed
the
fetch-submodules
branch
from
2ef4c22
to
681ddd5
Compare
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.
This PR adds an optional field
.spec.recurseSubmodulesto the GitRepository API. When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using thego-gitGitImplementation.Fix: #169
Addresses: fluxcd/flux2#326