diff options
| author | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-01 19:58:08 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-01 19:58:08 +0100 |
| commit | ed88bcea09c337fe9ede822ea88e7770a9c6ade0 (patch) | |
| tree | 7595e860b397c88df86d2759f7a2fd6d51be9a9a /docs | |
| parent | c7fdad42f68927d79e0d1963ade3324370b9d0e2 (diff) | |
| parent | fd73a738b429be0a2642d5b777d5e56a4c928787 (diff) | |
| download | gitlab-ed88bcea09c337fe9ede822ea88e7770a9c6ade0.tar.gz | |
Merge pull request #1646 from JacobHenner/add-merge-trains
feat(api): add merge trains
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-objects.rst | 1 | ||||
| -rw-r--r-- | docs/gl_objects/merge_trains.rst | 29 |
2 files changed, 30 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 567344f..9c089fe 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -29,6 +29,7 @@ API examples gl_objects/boards gl_objects/labels gl_objects/notifications + gl_objects/merge_trains gl_objects/mrs gl_objects/mr_approvals gl_objects/milestones diff --git a/docs/gl_objects/merge_trains.rst b/docs/gl_objects/merge_trains.rst new file mode 100644 index 0000000..c0920df --- /dev/null +++ b/docs/gl_objects/merge_trains.rst @@ -0,0 +1,29 @@ +############ +Merge Trains +############ + +Reference +--------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectMergeTrain` + + :class:`gitlab.v4.objects.ProjectMergeTrainManager` + + :attr:`gitlab.v4.objects.Project.merge_trains` + +* GitLab API: https://docs.gitlab.com/ee/api/merge_trains.html + +Examples +-------- + +List merge trains for a project:: + + merge_trains = project.merge_trains.list() + +List active merge trains for a project:: + + merge_trains = project.merge_trains.list(scope="active") + +List completed (have been merged) merge trains for a project:: + + merge_trains = project.merge_trains.list(scope="complete")
\ No newline at end of file |