Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Gauvain Pocentek
committed
Sep 21, 2017
1 parent
80351ca
commit a346f92
Showing
1 changed file
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,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 |