Skip to content

Commit

Permalink
ref/comment: update --publish options (#344)
Browse files Browse the repository at this point in the history
* ref/comment: update --publish options

- follow-up to iterative/cml#1208
- follow-up to iterative/cml#1210

* more explicit, harder to miss
  • Loading branch information
casperdcl authored Oct 18, 2022
1 parent ef45ea5 commit d8b2efd
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions content/docs/ref/comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,13 @@ Any [generic option](/doc/ref) in addition to:
- `--watch`: Watch for changes and automatically update the comment (doesn't
exit, consider
[appending `&` to run in the background](<https://en.wikipedia.org/wiki/Job_control_(Unix)#Implementation>)).
- `--publish`: Upload any local images found in the Markdown report.
- `--publish=<true|false>`: Upload any local images found in the Markdown
report.
- `--publish-native`: Uses `--driver`'s native capabilities to `--publish`
assets instead of `--publish-url` (not available on `--driver=github`).
- `--publish-url=<url>`: Self-hosted image server URL [default:
`https://asset.cml.dev`], see
[minroud-s3](https://github.com/iterative/minroud-s3).
- `--native`: Uses `--driver`'s native capabilities to `--publish` assets
instead of `--publish-url` (not available on `--driver=github`).

## FAQs and Known Issues

Expand Down

0 comments on commit d8b2efd

Please sign in to comment.