From 8a560c6ada94ec715e36b47ba722d5a128a4e154 Mon Sep 17 00:00:00 2001 From: Will Starms Date: Wed, 14 Sep 2016 19:03:29 -0500 Subject: [PATCH] Brief branch protection notes You can pass developers_can_push and developers_can_merge to the protect function. Handy! --- docs/gl_objects/branches.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst index 1b61af34c..50b97a799 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)``