kosli assert pullrequest github #
Synopsis #
Assert a Github pull request for a git commit exists.
The command exits with non-zero exit code
if no pull requests were found for the commit.
kosli assert pullrequest github [flags]
Flags #
| Flag | Description |
|---|---|
| --commit string | Git commit for which to find pull request evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). (default "HEAD") |
| -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. |
| --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 |
| --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). |
Flags 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") |
| --http-proxy string | [optional] The HTTP proxy URL including protocol and port number. e.g. 'http://proxy-server-ip:proxy-port' |
| -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 Use Cases #
These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.
kosli assert pullrequest github \
--github-token yourGithubToken \
--github-org yourGithubOrg \
--commit yourGitCommit \
--repository yourGithubGitRepository
