How to prevent direct commits to master branch using husky?

Question

I am using husky to run git hooks.

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }

I want to prevent direct commits to master branch. It should allow the master branch to be updated only by merge requests.

I came across following code from Git: Prevent commits in master branch. I copied this to .git/hooks/pre-commit and it works

#!/bin/sh

branch="$(git rev-parse --abbrev-ref HEAD)"

if [ "$branch" = "master" ]; then
  echo "You can't commit directly to master branch"
  exit 1
fi

But I want to achieve this using husky. How do I do that?

score 13 · Accepted Answer · answered Sep 25 '20 at 08:59

I created a file with the content provided from OP.

file: hooks/pre-commit

#!/bin/sh

branch="$(git rev-parse --abbrev-ref HEAD)"

if [ "$branch" = "master" ]; then
  echo "You can't commit directly to master branch"
  exit 1
fi

Then I added an entry to husky pre-commit field in package.json

  "husky": {
    "hooks": {
      "pre-commit": "sh hooks/pre-commit",
    }

No more commits to master :)

score 4 · Answer 2 · answered Aug 21 '19 at 08:31

4

With git-branch-is you can block commits with husky in master branch

"pre-commit": "git-branch-is -r \"^((?!master).)*$\""

answered Aug 21 '19 at 08:31

Gregor Albert

819
1
11
23

there is a `--not` since https://github.com/kevinoid/git-branch-is/pull/29 – muescha Jul 30 '20 at 12:37

score 4 · Answer 3 · answered Dec 11 '19 at 16:22

I don't think that's the right place to make this restriction because it can easily be bypassed. As an alternative, I would recommend you to modify the protection rules of the repository/branch.

Here is how it's done with GitHub and Bitbucket:

I know it's a different approach but I hope it's helpful too.

As a side note, It can't prevent pushing from admin – Yonggoo Noh May 17 '20 at 04:32 — Yonggoo Noh, May 17 '20 at 04:32

How to prevent direct commits to master branch using husky?

3 Answers3

Linked

Related