Skip to content

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

Notifications You must be signed in to change notification settings

bogdan-calapod/jira-smart-commit

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JIRA Smart Commits

Stable Version Build Status Dependabot Status MIT license Downloads PRs Welcome

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
  1. Install this package in your project:
npm install --save-dev jira-smart-commit
  1. 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"
  1. 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"

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%