Skip to content

Commit 7378ad7

Browse files
committed
Change note regarding git implementation field
The implementation is now ignored, in favour of just using libgit2. Signed-off-by: Michael Bridgen <[email protected]>
1 parent 0b63def commit 7378ad7

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/spec/v1alpha2/imageupdateautomations.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,11 @@ type SourceReference struct {
7070

7171
To be able to commit changes back, the referenced `GitRepository` object must refer to credentials
7272
with write access; e.g., if using a GitHub deploy key, "Allow write access" should be checked when
73-
creating it. Only the `url`, `ref`, `secretRef` and `gitImplementation` (see just below) fields of
74-
the `GitRepository` are used.
73+
creating it. Only the `url`, `ref`, and `secretRef` fields of the `GitRepository` are used.
7574

76-
The `gitImplementation` field in the referenced `GitRepository` object controls which git library is
77-
used. This will matter if you run on Azure, and possibly otherwise -- see [the source controller
78-
documentation][source-docs] for more details.
75+
The [`gitImplementation` field][source-docs] in the referenced `GitRepository` is ignored. The
76+
automation controller cannot use shallow clones or submodules, so there is no reason to use the
77+
go-git implementation rather than libgit2.
7978

8079
Other fields particular to how the Git repository is used are in the `git` field, [described
8180
below](#git-specific-specification).

0 commit comments

Comments
 (0)