Git commit hook to verify commit messages are tagged with a JIRA issue number
npm install jira-precommit-hookjira-precommit-hook
-------------------
Goals:
- Commit hook script contains the bare bones needed to call into this library.
We may want to investigate use of existing
pre-commit module.
Currently only configured for read-only access to JIRA.
In order to communicate with your JIRA server, a .jirarc file needs to be
placed in the root of the repo.
``json`
{
"projectName": "
"host":"
"protocol":"[default:http|https]",
"port": default:80,
"version": default:2,
"verbose": default:false,
"strictSSL": default:true
}
To install, run the following with npm:
`bash`
> npm install jira-precommit-hook
If the hooks directory in your .git folder is symlinked, the module will be
unable to find it. To avoid this, do not symlink your hooks folder inside of
your project's git directory.
_In order to make a successful commit with the precommit hook, ALL issues
being committed must meet the following requirements:_
- There must be at least one issue in the commit message
- All committed issues must exist in the project designated in the .jirarc
_At least one issue being committed must meet the following requirements:_
- The issue must be open for commits
- The parents of the issue must also be open for commits
- The issue must lead up to an initiative
- The issue must not be an initiative, epic, nor a deployment task
By default you will get a joke presented to you upon a successful commit. This
is two-fold, first to get you accustomed to the commit hook so you are aware
when it's not present. The second is for some comic relief at work, cause we
all need it.
`bash`
> ./node_modules/.bin/jira-precommit jokes disable
`bash``
> ./node_modules/.bin/jira-precommit jokes enable
To disable
To disable the joke feature simply delete the .chuckNorris file from your home directory.