Skip to content

docs: clarify --artifact-type=docker requires registry digest #834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexKantor87 merged 4 commits into from
Apr 28, 2026
+19 −2
Merged

docs: clarify --artifact-type=docker requires registry digest #834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55dfdd0
docs: clarify --artifact-type=docker requires registry digest
AlexKantor87 Apr 28, 2026
7848fbd
docs: drop dir suggestion from artifact-type=docker note
AlexKantor87 Apr 28, 2026
413507b
fix: align test data for artifact testing
mbevc1 Apr 28, 2026
8c9410a
fix: align test data for artifact testing - replace carets
mbevc1 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions cmd/kosli/fingerprint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ images in registries or "docker" for local docker images.
Fingerprinting container images can be done using the local docker daemon or the fingerprint can be fetched
from a remote registry.

Note: ^--artifact-type=docker^ reads the image's repo digest via the local Docker daemon, so
the image must have been pushed to or pulled from a registry. A freshly built image (just
^docker build^) does not have a repo digest. For images already in a registry, prefer
^--artifact-type=oci^ to fetch the digest directly from the registry.

` + fingerprintDirSynopsis

const fingerprintExamples = `
Expand Down
8 changes: 7 additions & 1 deletion cmd/kosli/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,18 @@ const (

// the following constants are used in the docs/help
fingerprintDesc = `
The artifact fingerprint can be provided directly with the ^--fingerprint^ flag, or
The artifact fingerprint can be provided directly with the ^--fingerprint^ flag, or
calculated based on ^--artifact-type^ flag.

Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container
images in registries or "docker" for local docker images.

Note: ^--artifact-type=docker^ reads the image's repo digest via the local Docker daemon.
The image must have been pushed to or pulled from a registry for a repo digest to exist;
a freshly built image (just ^docker build^) will not have one. If the image is already in
a registry, prefer ^--artifact-type=oci^, which fetches the digest directly from the
registry without needing a local Docker daemon.

`

attestationBindingDesc = `
Expand Down
8 changes: 7 additions & 1 deletion cmd/kosli/testdata/output/docs/mintlify/artifact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@ artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags]

Report an artifact creation to a Kosli flow.

The artifact fingerprint can be provided directly with the `--fingerprint` flag, or
The artifact fingerprint can be provided directly with the `--fingerprint` flag, or
calculated based on `--artifact-type` flag.

Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container
images in registries or "docker" for local docker images.

Note: `--artifact-type=docker` reads the image's repo digest via the local Docker daemon.
The image must have been pushed to or pulled from a registry for a repo digest to exist;
a freshly built image (just `docker build`) will not have one. If the image is already in
a registry, prefer `--artifact-type=oci`, which fetches the digest directly from the
registry without needing a local Docker daemon.



## Flags
Expand Down
Loading