fast-jira-commit
v1.2.0
Published
This is a CLI tool that makes committing easier by integrating with JIRA to generate commit messages
Downloads
6
Readme
This package makes your git commit
faster by providing the commit message
in case you use Jira.
The pattern of the commit message is: [JIRA_PROJECT_NAME][JIRA_ISSUE]: [JIRA_SUMMARY]
.
The prerequisite for this to work is that the branch name should include a valid Jira issue number.
Installation
npm i -g fast-jira-commit
How to use
Type command jc
Arguments:
-m"
This is a commit message"
- You can provide an additional commit message. This message will be appended to the one provided by the library.-r
- Reset configuration. You will be asked to fill the configuration again.-i"
{PROJECT_NAME}-{ISSUE_NUMBER}"
- By default the project name and number are extracted from the branch name, If your branch doesn't include that information you can provide it here.
Configuration
When you execute the script for the first time, you will be asked to configure the below:
Provide API_KEY
- This is the API key for Jira. - Go to Your JIRA profile -> Personal Access Tokens -> Create new token.Provide API URL
- This is the REST API URL of Jira. It should be like{JIRA_URL}/rest/api/2