https://github.com/pcnate/npm-nomaster-commits
simple dev module to add a pre-commit hook to block commits to master
https://github.com/pcnate/npm-nomaster-commits
commit git
Last synced: 6 months ago
JSON representation
simple dev module to add a pre-commit hook to block commits to master
- Host: GitHub
- URL: https://github.com/pcnate/npm-nomaster-commits
- Owner: pcnate
- License: mit
- Created: 2018-11-30T18:19:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T15:00:46.000Z (over 2 years ago)
- Last Synced: 2025-02-02T08:02:15.547Z (over 1 year ago)
- Topics: commit, git
- Language: JavaScript
- Homepage:
- Size: 320 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-nomaster-commits
## Description:
NPM package that adds a pre-commit hook that blocks commits to the master/main/truck branches of a git repository. May be optionally installed globally to provide commands to install the pre-commit hook into the local git repository.
> Security notice: this will create a shell script that gets executed by git on every commit. Be sure to verify the code does what I say it does if you have any concerns about security.
## Installation
Install as a dependency of an NPM package with the following command. This will install the package and activate the pre-commit hook.
`npm install --save-dev npm-nomaster-commits`
Install globally as a system command with the following command. This will allow `nomaster` and `nomain` to be executable commands that allow you to install or uninstall the pre-commit hook once in the current working directory if it contains a .git folder.
`npm install --global npm-nomaster-commits`
Then from a valid git repository run the following:
`nomaster --install`
`nomain --install`
## Usage:
* nomaster [options]
* nomain [options]
Examples:
* nomaster --install --directory /home/yourUser/github/yourRepository
* nomaster --install --directory c:\github\yourRepository
* nomaster --status
## Options:
| option | description |
|--|--|
| help | Shows this help file. This is the default if no other option is provided. |
| install | Install the pre-commit hook into the current .git folder of the current repository |
| uninstall | Remove the matching pre-commit hook from the current .git folder of the current repository |
| status | Shows the current installation status of the current working directory. It also will show if the current working directory is a valid git repository. |
| verbose | Increase the verbosity of logging for debug purposes |