by iterative.ai
Get started
Edit on GitHub

Command Reference: comment

create

Post a Markdown report as a comment on a commit or pull/merge request.

cml comment create [options] <markdown report file>

update

Update the last CML comment instead of creating a new one. If no previous comment is found, create a new one.

cml comment update [options] <markdown report file>

If there's an associated pull/merge request, consider using update with the --pr flag.

If cml pr was used earlier in the workflow, use --commit-sha=HEAD to post comments to the new PR if desired.

Options

Any generic option in addition to:

  • --commit-sha=<rev>, --head-sha=<rev>: Git revision linked to this comment [default: HEAD].
  • --pr: Post to an existing PR/MR associated with the specified commit.
  • --watch: Watch for changes and automatically update the comment (doesn't exit, consider appending & to run in the background).
  • --publish: Upload any local images found in the Markdown report.
  • --publish-url=<url>: Self-hosted image server URL [default: https://asset.cml.dev], see minroud-s3.
  • --native: Uses --driver's native capabilities to --publish assets instead of --publish-url (not available on --driver=github).

FAQs and Known Issues

GitHub

Bitbucket

  • Can't create a pull request or commit comment / Invalid or unknown installation.

    This happens because the Pull Request Commit Links application has not been installed into your BitBucket workspace. You can install it by following these instructions from the Bitbucket docs:

    Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details.

    We don't like ClickOps either, but it's the way it is.

Content

🐛 Found an issue? Let us know! Or fix it:

Edit on GitHub

Have a question? Join our chat, we will help you:

Discord Chat