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 stringThe 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.merkely.com/ci-defaults)
-u, --commit-url stringThe url for the git commit that created the artifact.
-C, --compliantWhether the artifact is compliant or not. (default true)
-d, --description string[optional] The artifact description.
-g, --git-commit stringThe git commit from which the artifact was created.
-h, --helphelp for creation
-p, --pipeline stringThe Kosli pipeline name.
--registry-password stringThe docker registry password or access token.
--registry-provider stringThe docker registry provider or url.
--registry-username stringThe docker registry username.
-s, --sha256 stringThe 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 "merkely")
-D, --dry-runWhether 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 stringThe Kosli endpoint. (default "https://app.merkely.com")
-r, --max-api-retries intHow many times should API calls be retried when the API host is not reachable. (default 3)
-o, --owner stringThe Kosli user or organization.
-v, --verbosePrint 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