giticket

Auto add ticket info to your git commits.

• Free software: MIT license
• Documentation: https://giticket.readthedocs.io.

Features

This hook saves developers time by prepending ticket numbers to commit-msgs. For this to work the following two conditions must be met:

• The ticket format regex specified must match, if the regex is passed in.
• Unless you use regex_match mode, the branch name format must be <ticket number>_<rest of the branch name>

For e.g. if you name your branch JIRA-1234_awesome_feature and commit Fix some bug, the commit will be updated to JIRA-1234 Fix some bug.

Conventional Commit Structure

Giticket now supports and enforces conventional commit structure. Your commit message must follow the format type(scope): message, and it will be automatically formatted as type(scope): ticket message.

The commit message must adhere to the following rules:

• Type: Must be one of the allowed types (case-insensitive, will be converted to lowercase):

  build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test, enh

• Scope: Must be one of the allowed scopes (case-insensitive, will be converted to uppercase):

  AL, ASM, AUTH, BADGE, BASE, CAM, CAR, CFG, CHECK, COMMENT, CP, CSL, CTE, DMD, DOC, DP, DS, DU, ELE, ES, EXDS, EXP, FAFSA, FEED, FNL, FORM, GEO, GOAL, GOL, GUARD, I18N, ILP, IPDB, IPPM, IS, K12ADMIN, KRI, LNP, MEET, MEMBER, MNGMT, MSG, NCAA, NOTE, NOTIF, ONB, OPPS, ORGPROF, PROF, QNA, RC, RDC, RES, RLBS, RLP, RONTAG, ROS, SCG, SCHOL, SCORE, SDH, SET, SIS, SS, STATS, STDH, SYE, TAG, TODO, UI, VR

For example:

• If your branch is feature/SP-1234/awesome-feature and you commit fix(CP): some bug, the commit will be updated to fix(CP): SP-1234 some bug.
• If your branch is feature/SP-5678/new-ui and you commit feat(UI): awesome feature, the commit will be updated to feat(UI): SP-5678 awesome feature.

If either the type or scope is invalid, or if the commit message format is incorrect, the commit process will be stopped with an error message. This ensures that all commits follow the conventional commit structure.

This helps maintain a consistent commit message format following conventional commit standards while automatically including the ticket number from your branch name.

Pass --regex= or update args: [--regex=<custom regex>] in your .yaml file if you have custom ticket regex. By default it's [A-Z]+-\d+.

Pass --format= or update args: [--format=<custom template string>] in your .yaml file if you have custom message replacement. By default it's '{ticket} {commit_msg}, where ticket is replaced with the found ticket number and commit_msg is replaced with the original commit message.

Pass --mode= or update args: [--mode=regex_match] in your .yaml file to extract ticket by the regex rather than relying on branch name convention. With this mode you can also make use of {tickets} placeholder in format argument value to put multiple comma-separated tickets in the commit message in case your branch contains more than one ticket.

It is best used along with pre-commit. You can use it along with pre-commit by adding the following hook in your .pre-commit-config.yaml file.

repos:
- repo:  https://github.com/milin/giticket
  rev: v1.4
  hooks:
  - id:  giticket
    args: ['--regex=PROJ-[0-9]', '--format={ticket} {commit_msg}']  # Optional

You need to have precommit setup to use this hook.

Install Pre-commit and the commit-msg hook-type.

pip install pre-commit
pre-commit install
pre-commit install --hook-type commit-msg