Commit5f03160

committed

feat(groups): add protectedbranches to group class (#3164)

1 parent10ee58a commit5f03160Copy full SHA for 5f03160

File tree

+67

-3

lines changed

+67

-3

lines changed

Lines changed: 8 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,8 @@`
`2`	`2`	`Protected branches`
`3`	`3`	`##################`
`4`	`4`
`5`		`-You can define a list of protected branch names on a repository. Names can use`
`6`		-wildcards (``*``).
	`5`	`+You can define a list of protected branch names on a repository or group.`
	`6`	+Names can usewildcards (``*``).
`7`	`7`
`8`	`8`	`References`
`9`	`9`	`----------`
`@@ -13,19 +13,24 @@ References`
`13`	`13`	+:class:`gitlab.v4.objects.ProjectProtectedBranch`
`14`	`14`	+:class:`gitlab.v4.objects.ProjectProtectedBranchManager`
`15`	`15`	+:attr:`gitlab.v4.objects.Project.protectedbranches`
	`16`	+ +:class:`gitlab.v4.objects.GroupProtectedBranch`
	`17`	+ +:class:`gitlab.v4.objects.GroupProtectedBranchManager`
	`18`	+ +:attr:`gitlab.v4.objects.Group.protectedbranches`
`16`	`19`
`17`	`20`	`* GitLab API: https://docs.gitlab.com/ce/api/protected_branches.html#protected-branches-api`
`18`	`21`
`19`	`22`	`Examples`
`20`	`23`	`--------`
`21`	`24`
`22`		`-Get the list of protected branches for a project::`
	`25`	`+Get the list of protected branches for a project or group::`
`23`	`26`
`24`	`27`	`p_branches = project.protectedbranches.list()`
	`28`	`+ p_branches = group.protectedbranches.list()`
`25`	`29`
`26`	`30`	`Get a single protected branch::`
`27`	`31`
`28`	`32`	`p_branch = project.protectedbranches.get('main')`
	`33`	`+ p_branch = group.protectedbranches.get('main')`
`29`	`34`
`30`	`35`	`Update a protected branch::`
`31`	`36`

Lines changed: 29 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -61,3 +61,32 @@ def get(`
`61`	`61`	`self,id:Union[str,int],lazy:bool=False,**kwargs:Any`
`62`	`62`	`)->ProjectProtectedBranch:`
`63`	`63`	`returncast(ProjectProtectedBranch,super().get(id=id,lazy=lazy,**kwargs))`
	`64`	`+`
	`65`	`+`
	`66`	`+classGroupProtectedBranch(SaveMixin,ObjectDeleteMixin,RESTObject):`
	`67`	`+_id_attr="name"`
	`68`	`+`
	`69`	`+`
	`70`	`+classGroupProtectedBranchManager(CRUDMixin,RESTManager):`
	`71`	`+_path="/groups/{group_id}/protected_branches"`
	`72`	`+_obj_cls=GroupProtectedBranch`
	`73`	`+_from_parent_attrs= {"group_id":"id"}`
	`74`	`+_create_attrs=RequiredOptional(`
	`75`	`+required=("name",),`
	`76`	`+optional=(`
	`77`	`+"push_access_level",`
	`78`	`+"merge_access_level",`
	`79`	`+"unprotect_access_level",`
	`80`	`+"allow_force_push",`
	`81`	`+"allowed_to_push",`
	`82`	`+"allowed_to_merge",`
	`83`	`+"allowed_to_unprotect",`
	`84`	`+"code_owner_approval_required",`
	`85`	`+ ),`
	`86`	`+ )`
	`87`	`+_update_method=UpdateMethod.PATCH`
	`88`	`+`
	`89`	`+defget(`
	`90`	`+self,id:Union[str,int],lazy:bool=False,**kwargs:Any`
	`91`	`+ )->GroupProtectedBranch:`
	`92`	`+returncast(GroupProtectedBranch,super().get(id=id,lazy=lazy,**kwargs))`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`from .audit_eventsimportGroupAuditEventManager# noqa: F401`
`23`	`23`	`from .badgesimportGroupBadgeManager# noqa: F401`
`24`	`24`	`from .boardsimportGroupBoardManager# noqa: F401`
	`25`	`+from .branchesimportGroupProtectedBranchManager# noqa: F401`
`25`	`26`	`from .clustersimportGroupClusterManager# noqa: F401`
`26`	`27`	`from .container_registryimportGroupRegistryRepositoryManager# noqa: F401`
`27`	`28`	`from .custom_attributesimportGroupCustomAttributeManager# noqa: F401`
`@@ -96,6 +97,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):`
`96`	`97`	`packages:GroupPackageManager`
`97`	`98`	`projects:GroupProjectManager`
`98`	`99`	`shared_projects:SharedProjectManager`
	`100`	`+protectedbranches:GroupProtectedBranchManager`
`99`	`101`	`pushrules:GroupPushRulesManager`
`100`	`102`	`registry_repositories:GroupRegistryRepositoryManager`
`101`	`103`	`runners:GroupRunnerManager`

Lines changed: 28 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -284,6 +284,34 @@ def test_group_hooks(group):`
`284`	`284`	`hook.delete()`
`285`	`285`
`286`	`286`
	`287`	`+deftest_group_protected_branches(group,gitlab_version):`
	`288`	`+# Updating a protected branch at the group level is possible from Gitlab 15.9`
	`289`	`+# https://docs.gitlab.com/api/group_protected_branches/`
	`290`	`+can_update_prot_branch=gitlab_version.major>15or (`
	`291`	`+gitlab_version.major==15andgitlab_version.minor>=9`
	`292`	`+ )`
	`293`	`+`
	`294`	`+p_b=group.protectedbranches.create(`
	`295`	`+ {`
	`296`	`+"name":"*-stable",`
	`297`	`+"allow_force_push":False,`
	`298`	`+ }`
	`299`	`+ )`
	`300`	`+assertp_b.name=="*-stable"`
	`301`	`+assertnotp_b.allow_force_push`
	`302`	`+assertp_bingroup.protectedbranches.list()`
	`303`	`+`
	`304`	`+ifcan_update_prot_branch:`
	`305`	`+p_b.allow_force_push=True`
	`306`	`+p_b.save()`
	`307`	`+`
	`308`	`+p_b=group.protectedbranches.get("*-stable")`
	`309`	`+ifcan_update_prot_branch:`
	`310`	`+assertp_b.allow_force_push`
	`311`	`+`
	`312`	`+p_b.delete()`
	`313`	`+`
	`314`	`+`
`287`	`315`	`deftest_group_transfer(gl,group):`
`288`	`316`	`transfer_group=gl.groups.create(`
`289`	`317`	`{"name":"transfer-test-group","path":"transfer-test-group"}`

Comments

(0)