kosli pipeline artifact report creation

kosli pipeline artifact report creation #

Report an artifact creation to a Kosli pipeline.

Synopsis #

Report an artifact creation to a Kosli pipeline. The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag).

kosli pipeline artifact report creation ARTIFACT-NAME-OR-PATH [flags]

Flags #

FlagDescription
-t, --artifact-type string[conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256'.
-b, --build-url stringThe url of CI pipeline that built the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ).
-u, --commit-url stringThe url for the git commit that created the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ).
-d, --description string[optional] The artifact description.
-g, --git-commit stringThe git commit from which the artifact was created. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ).
-h, --helphelp for creation
-p, --pipeline stringThe Kosli pipeline name.
--registry-password string[conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry.
--registry-provider string[conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry.
--registry-username string[conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry.
--repo-root string[defaulted] The directory where the source git repository is volume-mounted. (default ".")
-s, --sha256 string[conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'.

Options inherited from parent commands #

FlagDescription
-a, --api-token stringThe Kosli API token.
-c, --config-file string[optional] The Kosli config file path. (default "kosli")
-D, --dry-run[optional] Whether to run in dry-run mode. When enabled, data is not sent to Kosli and the CLI exits with 0 exit code regardless of errors.
-H, --host string[defaulted] The Kosli endpoint. (default "https://app.kosli.com")
-r, --max-api-retries int[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
--owner stringThe Kosli user or organization.
-v, --verbose[optional] Print verbose logs to stdout.

Examples #


# Report to a Kosli pipeline that a file type artifact has been created
kosli pipeline artifact report creation FILE.tgz \
	--api-token yourApiToken \
	--artifact-type file \
	--build-url https://exampleci.com \
	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom \
	--git-commit yourCommitShaThatThisArtifactWasBuiltFrom \
	--owner yourOrgName \
	--pipeline yourPipelineName 

# Report to a Kosli pipeline that an artifact with a provided fingerprint (sha256) has been created
kosli pipeline artifact report creation \
	--api-token yourApiToken \
	--build-url https://exampleci.com \
	--commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom \
	--git-commit yourCommitShaThatThisArtifactWasBuiltFrom \
	--owner yourOrgName \
	--pipeline yourPipelineName \
	--sha256 yourSha256