SyllaJay / enforce-branch-name

Little utility to be used in conjunction with Husky to enforce a branch naming convention

enforce-branch-name

Little utility to be used in conjunction with Husky to enforce a branch naming convention

Table of Contents

• enforce-branch-name
  • Table of Contents
  • Install
  • Usage
  • Contribute
  • License

Install

This project uses node and npm.

First make sure husky is installed. Then install enforce-branch-name:

$ npm install --save-dev enforce-branch-name
$ # OR
$ yarn add --dev enforce-branch-name

Usage

Now setup your hook:

// package.json
{
  "husky": {
    "hooks": {
      "pre-push": "enforce-branch-name '(hotfix|bugfix|feature)\/.+' --ignore 'staging'",
    }
  }
}

Contribute

1. Fork it and create your feature branch: git checkout -b my-new-feature
2. Commit your changes: git commit -am "Add some feature"
3. Push to the branch: git push origin my-new-feature
4. Submit a pull request

License

MIT