-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Command Reference: `pr` | ||
|
||
Commit specified files to a new branch and create a pull request. | ||
|
||
```dvc | ||
cml pr '**/*.py' '**/*.json' | ||
``` | ||
|
||
is roughly equivalent to: | ||
|
||
```dvc | ||
SHA="$(git log -n1 --format=%h)" | ||
BASE="$(git branch)" | ||
git checkout -b "${BASE}-cml-pr-${SHA}" | ||
git add *.py *.json | ||
git commit -m "CML PR for ${SHA} [skip ci]" | ||
git push | ||
gh pr create -B ${BASE} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Command Reference: `publish` | ||
|
||
Publish an image for inclusion in a CML report. | ||
|
||
To render an image in a markdown file: | ||
|
||
```dvc | ||
cml publish --md ./some-image.png >> report.md | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Command Reference: `runner` | ||
|
||
Starts a [runner](/doc/self-hosted-runners) (either via any supported cloud | ||
compute provider or locally on-premise). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Command Reference: `send-comment` | ||
|
||
```dvc | ||
cml send-comment some_content.md | ||
``` | ||
|
||
## Common error messages | ||
|
||
### Bitbucket | ||
|
||
- Can't create a pull request comment: the Pull Request Commit Links application | ||
has not been installed. | ||
|
||
We don't like ClickOps either but here's an actual | ||
[quote from the Bitbucket docs](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bcommit%7D/pullrequests): | ||
|
||
> 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Command Reference: `send-github-check` | ||
|
||
Similar to [`send-comment`](/doc/ref/send-comment), but using GitHub's | ||
[checks interface](https://docs.github.com/en/rest/reference/checks). | ||
|
||
```dvc | ||
cml send-github-check some_content.md | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Command Reference: `tensorboard-dev` | ||
|
||
Return a link to a <https://tensorboard.dev> page. | ||
|
||
```dvc | ||
cml tensorboard-dev | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters