kosli report evidence commit pullrequest github
#
kosli report evidence commit pullrequest github is a deprecated. see kosli attest commands Deprecated commands will be removed in a future release.
Synopsis
#
Report Github pull request evidence for a git commit in Kosli flows.
It checks if a pull request exists for a commit and report the pull-request evidence to the commit in Kosli.
kosli report evidence commit pullrequest github [flags]
Flags
#
| Flag |
Description |
| --assert |
[optional] Exit with non-zero code if no pull requests found for the given commit. |
| -b, --build-url string |
The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). |
| --commit string |
Git commit for which to verify a given evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). |
| -D, --dry-run |
[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| --evidence-fingerprint string |
[optional] The SHA256 fingerprint of the evidence file or dir. |
| --evidence-url string |
[optional] The external URL where the evidence file or dir is stored. |
| -f, --flows strings |
[defaulted] The comma separated list of Kosli flows. Defaults to all flows of the org. |
| --github-base-url string |
[optional] GitHub base URL (only needed for GitHub Enterprise installations). |
| --github-org string |
Github organization. (defaulted if you are running in GitHub Actions: https://docs.kosli.com/ci-defaults ). |
| --github-token string |
Github token. |
| -h, --help |
help for github |
| -n, --name string |
The name of the evidence. |
| --repository string |
Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). |
| -u, --user-data string |
[optional] The path to a JSON file containing additional data you would like to attach to the evidence. |
Options inherited from parent commands
#
| Flag |
Description |
| -a, --api-token string |
The Kosli API token. |
| -c, --config-file string |
[optional] The Kosli config file path. (default "kosli") |
| --debug |
[optional] Print debug logs to stdout. A boolean flag https://docs.kosli.com/faq/#boolean-flags (default false) |
| -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) |
| --org string |
The Kosli organization. |
Examples
#
# report a pull request commit evidence to Kosli
kosli report evidence commit pullrequest github \
--commit yourGitCommitSha1 \
--repository yourGithubGitRepository \
--github-token yourGithubToken \
--github-org yourGithubOrg \
--name yourEvidenceName \
--flows yourFlowName1,yourFlowName2 \
--build-url https://exampleci.com \
--org yourOrgName \
--api-token yourAPIToken
# fail if a pull request does not exist for your commit
kosli report evidence commit pullrequest github \
--commit yourGitCommitSha1 \
--repository yourGithubGitRepository \
--github-token yourGithubToken \
--github-org yourGithubOrg \
--name yourEvidenceName \
--flows yourFlowName1,yourFlowName2 \
--build-url https://exampleci.com \
--org yourOrgName \
--api-token yourAPIToken \
--assert
