summaryrefslogtreecommitdiff
path: root/docs/gl_objects/protected_branches.rst
blob: 4a6c8374b7d238e21d074c11bcea0139848f3f63 (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
##################
Protected branches
##################

You can define a list of protected branch names on a repository. Names can use
wildcards (``*``).

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectProtectedBranch`
  + :class:`gitlab.v4.objects.ProjectProtectedBranchManager`
  + :attr:`gitlab.v4.objects.Project.protectedbranches`

* GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api

Examples
--------

Get the list of protected branches for a project:

.. literalinclude:: branches.py
   :start-after: # p_branch list
   :end-before: # end p_branch list

Get a single protected branch:

.. literalinclude:: branches.py
   :start-after: # p_branch get
   :end-before: # end p_branch get

Create a protected branch:

.. literalinclude:: branches.py
   :start-after: # p_branch create
   :end-before: # end p_branch create

Delete a protected branch:

.. literalinclude:: branches.py
   :start-after: # p_branch delete
   :end-before: # end p_branch delete