@altar-io/cz-conventional-changelog-jira v1.0.1

cz-conventional-changelog-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

Preview

Quickstart

Installation

npm install commitizen @altar-io/cz-conventional-changelog-jira --save-dev

and then add the following to package.json:

{
  "scripts": {
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/@altar-io/cz-conventional-changelog-jira"
    }
  }
}

Usage

Configuration

Like commitizen, you can specify the configuration of cz-conventional-changelog-jira through the package.json's config.commitizen key, or with environment variables.

Jira Location Options

pre-type:

JIRA-123 type(scope): commit subject

pre-description:

type(scope): JIRA-123 commit subject

post-description:

type(scope): commit subject JIRA-123

post-body:

type(scope): commit subject

JIRA-123

type(scope): commit subject

this is a commit body

JIRA-123

Dynamic Configuration

Alternatively, if you want to create your own profile, you can use the configurable approach. Here is an example: ./cz-config.js

const custom = require('@altar-io/cz-conventional-changelog-jira/configurable');
// You can do this optionally if you want to extend the commit types
const defaultTypes = require('@altar-io/cz-conventional-changelog-jira/types');

module.exports = custom({
  types: {
    ...defaultTypes,
    perf: {
      description: 'Improvements that will make your code perform better',
      title: 'Performance',
    },
  },
  skipScope: false,
  scopes: ['myScope1', 'myScope2'],
  customScope: true,
});

./package.json

{
  "config": {
    "commitizen": {
      "path": "./cz-config.js"
    }
  }
}

This example would:

• Display "perf" as an extra commit type
• Ask you to add a commit scope
• Limit the scope selection to either myScope or myScope2

List of all supported configurable options when using the configurable approach:

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.