Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document cml send-github-check authentication #254

Merged
merged 1 commit into from
Jun 13, 2022
Merged

Document cml send-github-check authentication #254

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/docs/ref/send-github-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ cml send-github-check [options] <markdown report file>
Similar to [`send-comment`](/doc/ref/send-comment), but using GitHub's
[checks interface](https://docs.github.com/en/rest/reference/checks).

ⓘ Authentication must be done through an automatically generated
[`GITHUB_TOKEN`](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
or a
[GitHub App token](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps).
Personal access tokens can't be used to create checks.

## Options

Any [generic option](/doc/ref) in addition to:
Expand Down