kosli pipeline approval report

kosli pipeline approval report #

Report to Kosli an approval of deploying an artifact.

Synopsis #

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

kosli pipeline approval report [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'
-d, --description string[optional] The approval description.
-h, --helphelp for report
--newest-commit stringThe source commit sha for the newest change in the deployment. (default "HEAD")
--oldest-commit stringThe source commit sha for the oldest change in the deployment.
-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.
--repo-root stringThe directory where the source git repository is volume-mounted. (default ".")
-s, --sha256 stringThe SHA256 fingerprint for the artifact. Only required if you don't specify 'artifact-type'.
-u, --user-data string[optional] The path to a JSON file containing additional data you would like to attach to this approval.

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 that a file type artifact has been approved for deployment.
# The approval is for the last 5 git commits
kosli pipeline approval report FILE.tgz \
	--api-token yourAPIToken \
	--artifact-type file \
	--description "An optional description for the approval" \
	--newest-commit $(git rev-parse HEAD) \
	--oldest-commit $(git rev-parse HEAD~5) \
	--owner yourOrgName \
	--pipeline yourPipelineName 

# Report that an artifact with a provided fingerprint (sha256) has been approved for deployment.
# The approval is for the last 5 git commits
kosli pipeline approval report \
	--api-token yourAPIToken \
	--description "An optional description for the approval" \
	--newest-commit $(git rev-parse HEAD) \
	--oldest-commit $(git rev-parse HEAD~5) \
	--owner yourOrgName \
	--pipeline yourPipelineName \
	--sha256 yourSha256