Skip to content

Commit cef55c7

Browse files
committed
gitrepo: add docs for tag verification
Signed-off-by: Sanskar Jaiswal <jaiswalsanskar078@gmail.com>
1 parent 251dfa9 commit cef55c7

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

docs/spec/v1/gitrepositories.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -366,8 +366,17 @@ spec:
366366
`.spec.verify` is an optional field to enable the verification of Git commit
367367
signatures. The field offers two subfields:
368368

369-
- `.mode`, to specify what Git commit object should be verified. Only supports
370-
`head` at present.
369+
- `.mode`, to specify what Git object(s) should be verified. Supported
370+
values are:
371+
- `HEAD`: Verifies the commit object pointed to by the HEAD of the repository
372+
after performing a checkout via `.spec.ref`.
373+
- `head`: Same as `HEAD`, supported for backwards compatibility purposes.
374+
- `Tag`: Verifies the tag object pointed to by the specified/inferred tag
375+
reference in `.spec.ref.tag`, `.spec.ref.semver` or `.spec.ref.name`.
376+
- `TagAndHEAD`: Verifies the tag object pointed to by the specified/inferred tag
377+
reference in `.spec.ref.tag`, `.spec.ref.semver` or `.spec.ref.name` and
378+
the commit object pointed to by the tag.
379+
371380
- `.secretRef.name`, to specify a reference to a Secret in the same namespace as
372381
the GitRepository. Containing the (PGP) public keys of trusted Git authors.
373382

@@ -384,7 +393,7 @@ spec:
384393
ref:
385394
branch: master
386395
verify:
387-
mode: head
396+
mode: HEAD
388397
secretRef:
389398
name: pgp-public-keys
390399
```
@@ -978,6 +987,15 @@ status:
978987
...
979988
```
980989

990+
### Source Verification Mode
991+
992+
The source-controller reports the Git object(s) it verified in the Git
993+
repository to create an artifact in the GitRepository's
994+
`.status.sourceVerificationMode`. This value is the same as the [verification
995+
mode in spec](#verify). The verification status is applicable only to the
996+
latest Git repository revision used to successfully build and store an
997+
artifact.
998+
981999
### Observed Generation
9821000

9831001
The source-controller reports an [observed generation][typical-status-properties]

0 commit comments

Comments
 (0)