Merge pull request #1776 from python-gitlab/jlvillal/rebase_in_progress

Add some docs for getting the status of a merge_request rebase
python-gitlab · Dec 25, 2021 · e7d4d91 · e7d4d91
2 parents 83dcabf + bfa3dbe
commit e7d4d91
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -30,8 +30,8 @@ API examples
    gl_objects/labels
    gl_objects/notifications
    gl_objects/merge_trains
-   gl_objects/mrs
-   gl_objects/mr_approvals
+   gl_objects/merge_requests
+   gl_objects/merge_request_approvals.rst
    gl_objects/milestones
    gl_objects/namespaces
    gl_objects/notes

diff --git a/docs/gl_objects/mr_approvals.rst → docs/gl_objects/merge_request_approvals.rst b/docs/gl_objects/mr_approvals.rst → docs/gl_objects/merge_request_approvals.rst
diff --git a/docs/gl_objects/mrs.rst → docs/gl_objects/merge_requests.rst b/docs/gl_objects/mrs.rst → 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
@@ -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=(