Enabling branch protection based on the branch patterns.

[viks-confluent]

Prerequisites:

• Is the functionality available in the GitHub UI? If so, please provide a link to information about the feature.

Yes, from github UI, I can enable branch protection rules on pattern like *-release which will apply these rules to all the branches with -release as the suffix.

• Is the functionality available through the GitHub API? If the functionality is available, please provide links to the
  API documentation (https://developer.github.com/v3/) as well as the Octokit documentation (https://octokit.github.io/).

Yes, this is available via github graphQL api ONLY. https://docs.github.com/en/graphql/reference/mutations#createbranchprotectionrule
https://docs.github.com/en/graphql/reference/input-objects#createbranchprotectionruleinput

• If the functionality is not yet available in the API, it would be helpful if you
  contacted support (https://support.github.com/) or posted in the Community Forum (https://github.community/). Please
  include a link to the forum post if you create one or a copy of the response from support.

New Feature

Please describe the desired new functionality:

I want to enable branch protection rules based on a pattern. Today we can achieve this via Github UI and github graphQL apis. Adding this feature will help us to manage branch protection will less rules.

[philspokas]

We are hitting the same issue. wildcard patterns are pretty common especially for "release" style branching in which a release would be something like "release/v1.0.0" and so branch protection would be "release/*" and branch protection rules would be critically important to configure and keep aligned.

[lyoung-confluent]

It seems like other branch protection functionality/properties are available only via the GraphQL API (ex: #259) so it might be a good reason to transition the entire branch protection plugin to use the GraphQL endpoints instead of REST to make adoption of other fields easier/faster in the future.

This would make it a lot easier to manage as without it having multiple branches editing all of these into the ymls is a lot of time waste :(.

[anderssonjohan]

Just to point out that it's not only prefix/suffix patterns. This pattern is also possible to use: *[0-9].*[0-9x].x

[decyjphr]

I took a look at what needs to be done to change the Branch Protections code from REST to GraphQL. I see a few pain points

1. There is no API to get a branch protection. Only to get all branch protections for a repo and iterate through them
2. The https://docs.github.com/en/graphql/reference/input-objects#createbranchprotectionruleinput object has fields that are ID types and I have to get IDs for Apps, Users, Teams, repository, etc. before calling the API. That makes the API difficult to use. My goal was to modify safe-settings to use GraphQL instead of REST so that it can support wildcards.

Does anyone have ideas on how we can do this more efficiently?

[viks-confluent]

I took a look at what needs to be done to change the Branch Protections code from REST to GraphQL. I see a few pain points

1. There is no API to get a branch protection. Only to get all branch protections for a repo and iterate through them
2. The https://docs.github.com/en/graphql/reference/input-objects#createbranchprotectionruleinput object has fields that are ID types and I have to get IDs for Apps, Users, Teams, repository, etc. before calling the API. That makes the API difficult to use. My goal was to modify safe-settings to use GraphQL instead of REST so that it can support wildcards.

Does anyone have ideas on how we can do this more efficiently?

I have implemented graph based branch protection rules internally to fit our usecases internally. I can push my changes to branch over the weekend if that is helpful.

[decyjphr]

@viks-confluent yes, please 🙇🏾 That would be awesome.

[jefeish]

@decyjphr @viks-confluent

I have implemented graph based branch protection rules internally to fit our usecases internally. I can push my changes to branch over the weekend if that is helpful.

has this been added ?

[sthomson-wyn]

@jefeish Looks like their branch is here main-enterprise...viks-confluent:safe-settings:gql-branch-protection

[sthomson-wyn]

Noting that rulesets are now available https://docs.github.com/en/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository

Unfortunately they also cannot use wildcards in the REST api, and graphql would need to be used https://docs.github.com/en/enterprise-cloud@latest/rest/repos/rules?apiVersion=2022-11-28#get-rules-for-a-branch

[lcoelho-wyn]

Is there any idea when this will be fixed?

[jamochl]

Hey @viks-confluent, seems you have already implemented the fix on your fork. If it is working, would it be ok to make a PR into this main repo? That is if it suits the rules of making PR into this repo that is.