cz-conventional-changelog-for-jira
Part of the commitizen family. Prompts for conventional changelog standard and also prompts for a mandatory JIRA issue.
Features
- Works seamlessly with semantic-release
🚀 - Works seamlessly with Jira smart commits
- Automatically detects the Jira issue from the branch name
Quickstart
Installation
npm install commitizen @digitalroute/cz-conventional-changelog-for-jira
and then add the following to package.json:
{
"scripts": {
"commit": "git-cz"
},
"config": {
"commitizen": {
"path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira"
}
}
}
Usage
Configuration
Like commitizen, you can specify the configuration of cz-conventional-changelog-for-jira through the package.json's config.commitizen
key, or with environment variables.
Environment variable | package.json | Default | Description |
---|---|---|---|
CZ_JIRA_MODE | jiraMode | true | If this is set to true, CZ will ask for a Jira issue and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. |
CZ_MAX_HEADER_WIDTH | maxHeaderWidth | 72 | This limits how long a commit message head can be. |
CZ_MIN_HEADER_WIDTH | minHeaderWidth | 2 | This limits how short a commit message can be. |
CZ_MAX_LINE_WIDTH | maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. |
CZ_SKIP_SCOPE | skipScope | true | If scope should be used in commit messages. |
CZ_TYPE | defaultType | undefined | The default type. |
CZ_SCOPE | defaultScope | undefined | The default scope. |
CZ_SUBJECT | defaultSubject | undefined | A default subject. |
CZ_BODY | defaultBody | undefined | A default body. |
CZ_ISSUES | defaultIssues | undefined | A default issue. |
Commitlint
If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 72. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.