diff options
| author | Will Starms <vilhelmen@gmail.com> | 2016-09-14 19:03:29 -0500 |
|---|---|---|
| committer | Will Starms <vilhelmen@gmail.com> | 2016-09-14 19:03:29 -0500 |
| commit | 8a560c6ada94ec715e36b47ba722d5a128a4e154 (patch) | |
| tree | 62889b4e0e78a431b91d1f464e966d8e6d662f23 | |
| parent | ddba752eb20af39fa54e13a7f565108a4ad011e9 (diff) | |
| download | gitlab-8a560c6ada94ec715e36b47ba722d5a128a4e154.tar.gz | |
Brief branch protection notes
You can pass developers_can_push and developers_can_merge to the protect function. Handy!
| -rw-r--r-- | docs/gl_objects/branches.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst index 1b61af3..50b97a7 100644 --- a/docs/gl_objects/branches.rst +++ b/docs/gl_objects/branches.rst @@ -41,3 +41,10 @@ Protect/unprotect a repository branch: .. literalinclude:: branches.py :start-after: # protect :end-before: # end protect + +.. note:: + + By default, developers will not be able to push or merge into + protected branches. This can be changed by passing ``developers_can_push`` + or ``developers_can_merge`` like so: + ``branch.protect(developers_can_push=False, developers_can_merge=True)`` |