Renddslow / prepare-branch-commit

prepare-branch-commit

Add text to commits based on Jira ticket numbers in the branch name.

Install

$ yarn add --dev prepare-branch-commit

Usage

prepare-branch-commit is meant to be run as a Husky hook:

From Husky v7+

npx husky add .husky/prepare-commit-msg 'npx --no-install prepare-branch-commit "$(echo $)1"'

Husky v4 and below

{
  // ...
  "husky": {
    "prepare-commit-msg": "prepare-branch-commit"
  }
  // ...
}

Usage Examples

branch name: feature/ABC-123-new-screen
commit prefix: [ABC-123]

branch name: hotfix/FUN-456-ABC-123-bugfix-time
commit prefix: [ABC-123] [FUN-456]

GitHub Action Usage

The primary issue tag extraction step can also be used during GitHub Actions to extract issue tags to use as input for other steps. Default usage as follows:

steps:
  - name: Extract Issue Tags
    id: issues-default # usage: ${{ steps.issues-default.outputs.issue-tags }}
    uses: Renddslow/prepare-branch-commit@v1.0.1