bogdan-calapod/jira-smart-commit

A Node.js githook script that transforms commits into smart commits, prefixed with the JIRA issue tag.

JIRA Smart Commits

A Node.js git hook script to prefix commits automatically with the JIRA ticket, based on a branch name.

⚠ This fork removes the master/develop-only branch check.

Usage

Installation

1. Install Husky in your project to configure Git hooks easily

npm install --save-dev husky

2. Install this package in your project:

npm install --save-dev jira-smart-commit

3. Configure scripts in package.json. The script expects his first argument to be the JIRA tag of the project.

    "husky": {
        "hooks": {
            "commit-msg": "jira-smart-commit SPAN",
            "pre-commit": "lint-staged"
        }
    },

or environment variables

• TAG_MATCHER - regular expression
• TAG_MATCH_INDEX - match index
• DEBUG - if true will console log some data about branch, matches array etc

example: if your branches have feature/SPAN-1234/some-description template

"commit-msg": "TAG_MATCHER=\"^[^/]+/(SPAN-[0-9]+)\" TAG_MATCH_INDEX=1 jira-smart-commit"

4. Do your git commits like usual. If the branch was prefixed with a JIRA tag, your commit message will get prefixed with the same tag.

Branch: TAG-411-husky-git-hooks
Commit message: "Add git hooks to project" → "TAG-411 Add git hooks to project"