From b0d367e8dfc723135542c526da94a2a3ade2dcc6 Mon Sep 17 00:00:00 2001 From: Michael Bridgen Date: Wed, 2 Jun 2021 14:32:33 +0100 Subject: [PATCH] Change note regarding git implementation field The implementation is now ignored, in favour of just using libgit2. Signed-off-by: Michael Bridgen --- docs/spec/v1alpha2/imageupdateautomations.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/spec/v1alpha2/imageupdateautomations.md b/docs/spec/v1alpha2/imageupdateautomations.md index 48778864..0c395898 100644 --- a/docs/spec/v1alpha2/imageupdateautomations.md +++ b/docs/spec/v1alpha2/imageupdateautomations.md @@ -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).