diff --git a/content/docs/ref/ci.md b/content/docs/ref/ci.md new file mode 100644 index 00000000..eb4a1a42 --- /dev/null +++ b/content/docs/ref/ci.md @@ -0,0 +1,24 @@ +# Command Reference: `ci` + +```bash +cml ci [options] +``` + +Prepares Git repository for CML operations (setting Git `user.name` & +`user.email`, unshallow clone and undo CI oddities such as origin URL formatting +and HTTP remote proxies). + +## Options + +Any [generic option](/doc/ref). + +## Examples + +Instead of wrangling with +[unshallowing clones](https://stackoverflow.com/q/6802145) and +`git config user.email` before being able to `git commit` or use +[`cml pr`](/doc/ref/pr), simply run: + +```bash +cml ci +``` diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index 84de1c94..8e3d5ac2 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -45,7 +45,9 @@ jobs: - name: Generate data run: echo "Hello World" > output.txt - name: Create and merge PR - run: gh pr merge --rebase $(cml pr "output.txt") + run: | + cml ci + gh pr merge --rebase $(cml pr "output.txt") env: REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} ```