summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn L. Villalovos <john@sodarock.com>2021-12-23 10:38:07 -0800
committerJohn L. Villalovos <john@sodarock.com>2021-12-23 10:38:07 -0800
commitbfa3dbe516cfa8824b720ba4c52dd05054a855d7 (patch)
treea7512e591cd9c085f6b34e96687f9e5dfafff6d2
parentee3f8659d48a727da5cd9fb633a060a9231392ff (diff)
downloadgitlab-jlvillal/rebase_in_progress.tar.gz
chore: add and document optional parameters for get MRjlvillal/rebase_in_progress
Add and document (some of the) optional parameters that can be done for a `project.merge_requests.get()` Closes #1775
-rw-r--r--docs/gl_objects/merge_requests.rst8
-rw-r--r--gitlab/v4/objects/merge_requests.py5
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/gl_objects/merge_requests.rst b/docs/gl_objects/merge_requests.rst
index 9ec69e5..351c5a3 100644
--- a/docs/gl_objects/merge_requests.rst
+++ b/docs/gl_objects/merge_requests.rst
@@ -186,6 +186,14 @@ Attempt to rebase an MR::
mr.rebase()
+Get status of a rebase for an MR::
+
+ mr = project.mergerequests.get(mr_id, include_rebase_in_progress=True)
+ print(mr.rebase_in_progress, mr.merge_error)
+
+For more info see:
+https://docs.gitlab.com/ee/api/merge_requests.html#rebase-a-merge-request
+
Attempt to merge changes between source and target branch::
response = mr.merge_ref()
diff --git a/gitlab/v4/objects/merge_requests.py b/gitlab/v4/objects/merge_requests.py
index bede4bd..11c962b 100644
--- a/gitlab/v4/objects/merge_requests.py
+++ b/gitlab/v4/objects/merge_requests.py
@@ -396,6 +396,11 @@ class ProjectMergeRequestManager(CRUDMixin, RESTManager):
_path = "/projects/{project_id}/merge_requests"
_obj_cls = ProjectMergeRequest
_from_parent_attrs = {"project_id": "id"}
+ _optional_get_attrs = (
+ "render_html",
+ "include_diverged_commits_count",
+ "include_rebase_in_progress",
+ )
_create_attrs = RequiredOptional(
required=("source_branch", "target_branch", "title"),
optional=(