kosli_assert_pullrequest_github.md

title	kosli assert pullrequest github
description	Assert a Github pull request for a git commit exists.

Synopsis

kosli assert pullrequest github [flags]

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.

Flags

Flag	Type	Description
--commit	string	Git commit for which to find pull request evidence. (defaulted in some CIs: docs ). (default "HEAD")
-D, --dry-run	bool	[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: docs ).
--github-token	string	Github token.
-h, --help	bool	help for github
--repository	string	Git repository. (defaulted in some CIs: docs ).

Flags inherited from parent commands

Flag	Type	Description
-a, --api-token	string	The Kosli API token.
-c, --config-file	string	[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default "$HOME/.kosli.yml")
--debug	bool	[optional] Print debug logs to stdout.
-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.
-q, --quiet	bool	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both --quiet and --debug are set, --debug wins.

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