From 7819910180e11d0d20c4174429d54d6630b8e3e3 Mon Sep 17 00:00:00 2001 From: Helio Machado <0x2b3bfa0+git@googlemail.com> Date: Wed, 16 Mar 2022 23:13:37 +0100 Subject: [PATCH 1/5] Document cml pr --auto-merge --- content/docs/ref/pr.md | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index 8e3d5ac2..61469e42 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -17,6 +17,8 @@ preventing an infinite chain of runs. Any [generic option](/doc/ref) in addition to: +- `--auto-merge`: Mark the PR/MR for automatic merging after tests pass + (unsupported by Bitbucket). - `--md`: Produce output in markdown format (`[CML Pull/Merge Request](url)` instead of `url`). - `--remote=`: Git remote name or URL [default: `origin`]. @@ -32,27 +34,7 @@ Any [generic option](/doc/ref) in addition to: cml pr "." ``` -### Automatically merge GitHub pull requests - -```yaml -on: pull_request -jobs: - cml: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: iterative/setup-cml@v1 - - name: Generate data - run: echo "Hello World" > output.txt - - name: Create and merge PR - run: | - cml ci - gh pr merge --rebase $(cml pr "output.txt") - env: - REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }} -``` - -### Command internals +## Command internals ```bash cml pr "**/*.py" "**/*.json" From 039ce45f9648b983d68082c438df3f95dd2d9470 Mon Sep 17 00:00:00 2001 From: Helio Machado <0x2b3bfa0+git@googlemail.com> Date: Thu, 17 Mar 2022 03:20:28 +0000 Subject: [PATCH 2/5] Apply review suggestions --- content/docs/ref/pr.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index 61469e42..2d127c5f 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -31,7 +31,14 @@ Any [generic option](/doc/ref) in addition to: ### Commit all files in current working directory ```bash -cml pr "." +cml pr . +``` + +### Automatically merge pull requests + +```bash +date > output.txt +cml pr --auto-merge output.txt ``` ## Command internals From 873025832beda30bab69caf14ec8e5464881472f Mon Sep 17 00:00:00 2001 From: Helio Machado <0x2b3bfa0+git@googlemail.com> Date: Thu, 17 Mar 2022 03:31:28 +0000 Subject: [PATCH 3/5] Add description for --auto-merge --- content/docs/ref/pr.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index 2d127c5f..ae36ff84 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -41,6 +41,9 @@ date > output.txt cml pr --auto-merge output.txt ``` +The `--auto-merge` option enables [auto–merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request) (GitHub) or +[merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) (GitLab) so the pull/merge request gets automatically merged as soon as checks succeed. + ## Command internals ```bash From b3ef0d0d363171faba096e714cc9d56858f72765 Mon Sep 17 00:00:00 2001 From: Helio Machado <0x2b3bfa0+git@googlemail.com> Date: Thu, 17 Mar 2022 03:33:15 +0000 Subject: [PATCH 4/5] Reword --- content/docs/ref/pr.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index ae36ff84..3f039e74 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -41,8 +41,12 @@ date > output.txt cml pr --auto-merge output.txt ``` -The `--auto-merge` option enables [auto–merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request) (GitHub) or -[merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) (GitLab) so the pull/merge request gets automatically merged as soon as checks succeed. +The `--auto-merge` option enables +[auto–merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request) +(GitHub) or +[merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) +(GitLab) to merge the pull/merge request as soon as checks +succeed. ## Command internals From e493d48ab912659b1f0aa0c1d18eb73dcff9a3a8 Mon Sep 17 00:00:00 2001 From: Helio Machado <0x2b3bfa0+git@googlemail.com> Date: Fri, 18 Mar 2022 00:51:58 +0000 Subject: [PATCH 5/5] Lint again --- content/docs/ref/pr.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/docs/ref/pr.md b/content/docs/ref/pr.md index 3f039e74..5d7de57b 100644 --- a/content/docs/ref/pr.md +++ b/content/docs/ref/pr.md @@ -45,8 +45,7 @@ The `--auto-merge` option enables [auto–merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request) (GitHub) or [merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) -(GitLab) to merge the pull/merge request as soon as checks -succeed. +(GitLab) to merge the pull/merge request as soon as checks succeed. ## Command internals