summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/merge_requests.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst
index 02121dc..fd57e60 100644
--- a/docs/gl_objects/merge_requests.rst
+++ b/docs/gl_objects/merge_requests.rst
@@ -122,8 +122,14 @@ Accept a MR::
mr.merge()
-Cancel a MR when the build succeeds::
+Schedule a MR to merge after the pipeline(s) succeed::
+ mr.merge(merge_when_pipeline_succeeds=True)
+
+Cancel a MR from merging when the pipeline succeeds::
+
+ # Cancel a MR from being merged that had been previously set to
+ # 'merge_when_pipeline_succeeds=True'
mr.cancel_merge_when_pipeline_succeeds()
List commits of a MR::