Command Reference: check

cml check create [options] <markdown report file>

Similar to comment create, but using GitHub's checks interface.

Options

Any generic option in addition to:

• --commit-sha=<ref>, --head-sha=<ref>: Git revision linked to this check [default: HEAD].
• --title=<...>: The check's title [default: CML Report].
• --status={queued,in_progress,completed}: The check's current status [default: completed].
• --conclusion={success,failure,neutral,cancelled,skipped,timed_out}: The check's final status [default: success].

FAQs and Known Issues

GitHub

• CML Report Expected — Waiting for status to be reported.

  Authentication must be done through an automatically-generated GITHUB_TOKEN or a GitHub App token. Personal access tokens (PATs) can't be used to create checks.