summaryrefslogtreecommitdiff
path: root/docs/gl_objects/milestones.rst
blob: 47e585ae39ca47d485d78445f322774fa12ec593 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
##########
Milestones
##########

Use :class:`~gitlab.objects.ProjectMilestone` objects to manipulate milestones.
The :attr:`gitlab.Gitlab.project_milestones` and :attr:`Project.milestones
<gitlab.objects.Project.milestones>` manager objects provide helper functions.

Examples
--------

List the milestones for a project:

.. literalinclude:: milestones.py
   :start-after: # list
   :end-before: # end list

You can filter the list using the following parameters:

* ``iid``: unique ID of the milestone for the project
* ``state``: either ``active`` or ``closed``

.. literalinclude:: milestones.py
   :start-after: # filter
   :end-before: # end filter

Get a single milestone:

.. literalinclude:: milestones.py
   :start-after: # get
   :end-before: # end get

Create a milestone:

.. literalinclude:: milestones.py
   :start-after: # create
   :end-before: # end create

Edit a milestone:

.. literalinclude:: milestones.py
   :start-after: # update
   :end-before: # end update

Change the state of a milestone (activate / close):

.. literalinclude:: milestones.py
   :start-after: # state
   :end-before: # end state

List the issues related to a milestone:

.. literalinclude:: milestones.py
   :start-after: # issues
   :end-before: # end issues

List the merge requests related to a milestone:

.. literalinclude:: milestones.py
   :start-after: # merge_requests
   :end-before: # end merge_requests