refactor(objects): remove deprecated branch protect methods

nejch · JohnVillalovos · commit 9656a16f9f34 · 2021-10-06T12:09:22.000-07:00
BREAKING CHANGE: remove deprecated branch protect methods in favor of
the more complete protected branches API.
diff --git a/docs/gl_objects/branches.rst b/docs/gl_objects/branches.rst
@@ -35,21 +35,8 @@ Delete a repository branch::
     # or
     branch.delete()
 
-Protect/unprotect a repository branch::
-
-    branch.protect()
-    branch.unprotect()
-
-.. note::
-
-   By default, developers are not authorized to push or merge into protected
-   branches. This can be changed by passing ``developers_can_push`` or
-   ``developers_can_merge``:
-
-   .. code-block:: python
-
-      branch.protect(developers_can_push=True, developers_can_merge=True)
-
 Delete the merged branches for a project::
 
     project.delete_merged_branches()
+
+To manage protected branches, see :doc:`/gl_objects/protected_branches`.
diff --git a/gitlab/v4/objects/branches.py b/gitlab/v4/objects/branches.py
@@ -1,5 +1,3 @@
-from gitlab import cli
-from gitlab import exceptions as exc
 from gitlab.base import RequiredOptional, RESTManager, RESTObject
 from gitlab.mixins import NoUpdateMixin, ObjectDeleteMixin
 
@@ -14,50 +12,6 @@
 class ProjectBranch(ObjectDeleteMixin, RESTObject):
     _id_attr = "name"
 
-    @cli.register_custom_action(
-        "ProjectBranch", tuple(), ("developers_can_push", "developers_can_merge")
-    )
-    @exc.on_http_error(exc.GitlabProtectError)
-    def protect(self, developers_can_push=False, developers_can_merge=False, **kwargs):
-        """Protect the branch.
-
-        Args:
-            developers_can_push (bool): Set to True if developers are allowed
-                                        to push to the branch
-            developers_can_merge (bool): Set to True if developers are allowed
-                                         to merge to the branch
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabProtectError: If the branch could not be protected
-        """
-        id = self.get_id().replace("/", "%2F")
-        path = "%s/%s/protect" % (self.manager.path, id)
-        post_data = {
-            "developers_can_push": developers_can_push,
-            "developers_can_merge": developers_can_merge,
-        }
-        self.manager.gitlab.http_put(path, post_data=post_data, **kwargs)
-        self._attrs["protected"] = True
-
-    @cli.register_custom_action("ProjectBranch")
-    @exc.on_http_error(exc.GitlabProtectError)
-    def unprotect(self, **kwargs):
-        """Unprotect the branch.
-
-        Args:
-            **kwargs: Extra options to send to the server (e.g. sudo)
-
-        Raises:
-            GitlabAuthenticationError: If authentication is not correct
-            GitlabProtectError: If the branch could not be unprotected
-        """
-        id = self.get_id().replace("/", "%2F")
-        path = "%s/%s/unprotect" % (self.manager.path, id)
-        self.manager.gitlab.http_put(path, **kwargs)
-        self._attrs["protected"] = False
-
 
 class ProjectBranchManager(NoUpdateMixin, RESTManager):
     _path = "/projects/%(project_id)s/repository/branches"
