Skip to content

Commit

Permalink
Change note regarding git implementation field
Browse files Browse the repository at this point in the history
The implementation is now ignored, in favour of just using libgit2.

Signed-off-by: Michael Bridgen <michael@weave.works>
  • Loading branch information
squaremo committed Jun 2, 2021
1 parent cc63809 commit b0d367e
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/spec/v1alpha2/imageupdateautomations.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,11 @@ type SourceReference struct {

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

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

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

0 comments on commit b0d367e

Please sign in to comment.