Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

github - enable branch lock

As a GitHub administrator, I would like to lock a particular branch in GitHub for all users. For e.g. if I do not want anyone to push to Master/Production or a Project branch, how can I do that.

Instead of using any client side hooks, is there a way to lock a branch on GitHub server directly ? Are there any third party tools/api's/scripts which can help achieve this ?

like image 496
Saurabh Porwal Avatar asked Mar 30 '15 00:03

Saurabh Porwal


People also ask

What is GitHub branch protection?

You can protect important branches by setting branch protection rules, which define whether collaborators can delete or force push to the branch and set requirements for any pushes to the branch, such as passing status checks or a linear commit history.


2 Answers

@Saurabh, I have done a similar thing according to your requirement on GitHub:

  • Navigate to Settings
  • Navigate to Branches
  • Tap on Add Rule near "Branch protection rules"
  • Tick the Require pull request reviews before merging checkbox

These steps apply a lock on, for example to master, so that no collaborators can push code to this branch. Code only be merged using pull requests.

Link to documentation

Screenshots:

enter image description here

enter image description here

enter image description here

Note: Protected branches are available to Pro, Team, and Enterprise users

note pro feature only

like image 59
CrazyPro007 Avatar answered Sep 30 '22 19:09

CrazyPro007


The easiest solution is to have that branch in its own repo (for which no collaborators) are declared.

Otherwise, GitHub doesn't provide any native "branch protection" feature, as mentioned in "How to protect “master” in github?"

You could setup a webhook which on a push event can refuse the push if the branch has a given name.

An example would be terite/pull-to-master which protects master:

if (json.ref != 'refs/heads/master')
  return cb([200, 'Skipping, not master']);

This is not a client-side hook, but it does require a client to listen to the JSON payload of the push event in order to react to it.

like image 22
VonC Avatar answered Sep 30 '22 18:09

VonC