Add support for new protected branches features on the Branch API

Zendesk issue: https://gitlab.zendesk.com/agent/tickets/40761

The current RepoBranch entity in the API exposes the boolean for whether developers can push or merge, but doesn't include the more granular details of the new EE protected branch feature. It should be possible to see whether masters can push or merge and specific people, as well.

https://docs.gitlab.com/ee/api/branches.html#list-repository-branches

Specification

• GET /projects/:id/repository/branches and GET /projects/:id/repository/branches/:branch should return additional information
  • Can masters push?
  • Can masters merge?
  • List of specific users who can push
  • List of specific users who can merge?

That might look like

[
  {
    "name": "master",
    "protected": true,
    "developers_can_push": false,
    "developers_can_merge": false,
    "masters_can_push": false,
    "masters_can_merge": false,
    "users_with_push_rights": [{
        ...
     }],
    "users_with_merge_rights": [{
        ...
     }],
    "commit": {
      ...
    }
  },
  ...
]

• Ability to update those protection settings

Added ~157389 ~155975 labels

cc @timothyandrew

cc/ @gl-product

Oh yeah, we should add this.

Milestone changed to %8.14

@regisF can you work this one out?

Reassigned to @regisF

Added ~481018 and removed ~157389 ~113221 ~155975 labels

Added ~157389 ~113221 ~155975 labels

@JobV Updated the body of the issue with what we should do.

Assignee removed

Changed title: Branch API does not expose new protected branch features → Add support for new protected branches features on the Branch API

@regisF Should we also support changing the protection? We would need more endpoints, and the property names would likely change to be more in line with the actual data model.

Milestone changed to %16

@DouweM It's unclear.

@dblessing do you think we should support POST as well?

@regisF Yes, I think that would be good.

@dblessing thanks for your input, I've updated the body of the issue.

Not quite following who is asking what, but as a user, I'd definitely like to be able to modify these settings via API.

mentioned in issue #1483

+1 for feature development.

GET and PUT/POST should be supported so that we can configure a project from an API, just like from the UI.

+1 This would be a great, especially with PUT/POST support. We have some Gitlab groups where we want nobody to be able to push to master directly. Settings this per project in the UI is quite a drag.

+1 on this, we would certainly use this.

Another customer request for this: https://gitlab.zendesk.com/agent/tickets/76637.

Specifically, the ability to, via the API, add/remove specific users that are allowed to push/merge.

@DouweM, could we take another look at this? It's been requested a number of times since it was moved to Backlog 6 months ago.

added customer+ label

Related issue:

• https://gitlab.com/gitlab-org/gitlab-ce/issues/30102

/cc @timothyandrew

/cc @mydigitalself

changed milestone to %9.4

added Deliverable label

+1 for sure! This is a definite need, more so with PUT/POST, and actually what caused me to go looking for a gitlab issue tracker and register once I found it. Happy to see that it's already milestoned for 9.4, so we'll keep an eye out for it.

We script the creation of our release branches, and currently have a manual step to go and protect them all.

mentioned in issue #1176 (closed)

changed milestone to %10.0

More interest via ZD: https://gitlab.zendesk.com/agent/tickets/80334

In addition to setting groups or users, we need the ability to specify 'No one'.

Bummed to see this delayed. We have to continue doing this manually for about 30 projects every release when we create release branches, until this feature is implemented. sigh

2-3 month milestone set 3 months ago.

changed milestone to %10.3

assigned to @jramsay

How does this relate to the new protected_branches API (See https://docs.gitlab.com/ee/api/protected_branches.html and https://gitlab.com/gitlab-org/gitlab-ce/issues/30102) and this issue: https://gitlab.com/gitlab-org/gitlab-ce/issues/35867?

Since according to https://docs.gitlab.com/ee/api/branches.html#protect-repository-branch this API is deprecated.

I think you bring up a good point Raphael. This issue was created at an older date. When they addressed 30102 for 9.5 they probably needed to close this one with a reference to the newer API. Thanks for pointing this out.

It's still not complete, but happy to see 35867 to completed it, and that they clarified they will add support for allowing specific users and groups in the new API.

ZD: https://gitlab.zendesk.com/agent/tickets/84608

assigned to @jamedjo

ZD ticket: https://gitlab.zendesk.com/agent/tickets/84857

Closing in favour of https://gitlab.com/gitlab-org/gitlab-ce/issues/35867

closed

added Enterprise Edition label