summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-12-25 13:21:04 +0100
committerGitHub <noreply@github.com>2021-12-25 13:21:04 +0100
commite7d4d9148a1bb8302c63fcd780d8dda416015248 (patch)
treea7512e591cd9c085f6b34e96687f9e5dfafff6d2
parent83dcabf3b04af63318c981317778f74857279909 (diff)
parentbfa3dbe516cfa8824b720ba4c52dd05054a855d7 (diff)
downloadgitlab-e7d4d9148a1bb8302c63fcd780d8dda416015248.tar.gz
Merge pull request #1776 from python-gitlab/jlvillal/rebase_in_progress
Add some docs for getting the status of a merge_request rebase
-rw-r--r--docs/api-objects.rst4
-rw-r--r--docs/gl_objects/merge_request_approvals.rst (renamed from docs/gl_objects/mr_approvals.rst)0
-rw-r--r--docs/gl_objects/merge_requests.rst (renamed from docs/gl_objects/mrs.rst)8
-rw-r--r--gitlab/v4/objects/merge_requests.py5
4 files changed, 15 insertions, 2 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 984fd4f..a36c1c3 100644
--- 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 b/docs/gl_objects/merge_request_approvals.rst
index 2c1b840..2c1b840 100644
--- a/docs/gl_objects/mr_approvals.rst
+++ b/docs/gl_objects/merge_request_approvals.rst
diff --git a/docs/gl_objects/mrs.rst b/docs/gl_objects/merge_requests.rst
index 9ec69e5..351c5a3 100644
--- a/docs/gl_objects/mrs.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=(