husky-pivotal

Husky + Pivotal

Husky hook commands to keep commits tied to Pivotal Tracker stories.

Installation

1. Set up Husky
2. npm install husky-pivotal --save-dev
3. Add one or more of the hook commands to suit your needs:

Hook commands

hup-mkmsg automatically adds story references to new commits

The hup-mkmsg command looks for a Pivotal Tracker Story ID in the current branch name and then uses it to prefill new commit messages with a [#____] format story reference. For example, if you're working in a branch named 123456-new-feature then [#123456] will be prefilled in new commit messages created within that branch.

To use this command, add hup-mkmsg to your Husky prepare-commit-msg hook:

npx husky add .husky/prepare-commit-msg 'npx --no-install hup-mkmsg "$1"'

hup-ckmsg disallows commits without story references

The hup-ckmsg command checks that commit messages contain a [#____] format story reference. The commit is aborted if it doesn't contain a story reference.

To use this command, add hup-ckmsg to your Husky commit-msg hook:

npx husky add .husky/commit-msg 'npx --no-install hup-ckmsg "$1"'

hup-ckbranch disallows commits outside of story branches

The hup-ckbranch command checks that the current branch name contains a Pivotal Tracker Story ID. Commits are aborted if the branch name doesn't contain a Story ID.

To use this command, add hup-ckbranch to your Husky pre-commit hook:

npx husky add .husky/pre-commit 'npx --no-install ckbranch'

License

MIT