Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@digitalroute/cz-conventional-changelog-for-jira

Package Overview
Dependencies
Maintainers
6
Versions
41
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@digitalroute/cz-conventional-changelog-for-jira

Commitizen adapter following the conventional-changelog format and also asking for JIRA issue.

  • 8.0.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
6
Created
Source

cz-conventional-changelog-for-jira

Part of the commitizen/cz-cli family. Prompts for conventional changelog standard and also prompts for a mandatory JIRA issue.

npm version npm downloads Build Status

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

Gif of terminal when using cz-conventional-changelog-for-jira

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 variablepackage.jsonDefaultDescription
CZ_JIRA_MODEjiraModetrueIf 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_WIDTHmaxHeaderWidth72This limits how long a commit message head can be.
CZ_MIN_HEADER_WIDTHminHeaderWidth2This limits how short a commit message can be.
CZ_MAX_LINE_WIDTHmaxLineWidth100Commit message bodies are automatically wrapped. This decides how long the lines will be.
CZ_SKIP_SCOPEskipScopetrueIf scope should be used in commit messages.
CZ_SKIP_TYPEskipTypefalseIf type should be used in commit messages.
CZ_SKIP_DESCRIPTIONskipDescriptionfalseIf description should be used in commit messages.
CZ_SKIP_BREAKINGskipBreakingfalseIf breaking changes should be used in commit messages.
scopesundefinedA list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'.
CZ_TYPEdefaultTypeundefinedThe default type.
CZ_SCOPEdefaultScopeundefinedThe default scope.
CZ_CUSTOM_SCOPEcustomScopefalseWhether user can provide custom scope in addition to predefined ones
CZ_SUBJECTdefaultSubjectundefinedA default subject.
CZ_BODYdefaultBodyundefinedA default body.
CZ_ISSUESdefaultIssuesundefinedA default issue.
CZ_JIRA_OPTIONALjiraOptionalfalseIf this is set to true, you can leave the JIRA field blank.
CZ_JIRA_PREFIXjiraPrefix"DAZ"If this is set it will be displayed as the default JIRA ticket prefix
CZ_JIRA_LOCATIONjiraLocation"pre-description"Changes position of JIRA ID. Options: pre-type, pre-description, post-description, post-body
CZ_JIRA_PREPENDjiraPrepend""Prepends JIRA ID with an optional decorator. e.g.: [DAZ-1234
CZ_JIRA_APPENDjiraAppend""Appends JIRA ID with an optional decorator. e.g.: DAZ-1234]
CZ_EXCLAMATION_MARKexclamationMarkfalseOn breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1.

Jira Location Options

pre-type:

JIRA-1234 type(scope): commit subject

pre-description:

type(scope): JIRA-1234 commit subject

post-description:

type(scope): commit subject JIRA-1234

post-body:

type(scope): commit subject

JIRA-1234
type(scope): commit subject

this is a commit body

JIRA-1234

Dynamic Configuration

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

const custom = require('@digitalroute/cz-conventional-changelog-for-jira/configurable');
// You can do this optionally if you want to extend the commit types
const defaultTypes = require('@digitalroute/cz-conventional-changelog-for-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": "./index.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:

KeyDefaultDescription
jiraModetrueIf 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.
maxHeaderWidth72This limits how long a commit message head can be.
minHeaderWidth2This limits how short a commit message can be.
maxLineWidth100Commit message bodies are automatically wrapped. This decides how long the lines will be.
skipScopetrueIf scope should be used in commit messages.
defaultTypeundefinedThe default type.
defaultScopeundefinedThe default scope.
defaultSubjectundefinedA default subject.
defaultBodyundefinedA default body.
defaultIssuesundefinedA default issue.
jiraPrefix'DAZ'The default JIRA ticket prefix that will be displayed.
types./types.jsA list (JS Object) of supported commit types.
scopesundefinedA list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'.
customScopefalseIf this is set to true, users are given an option to provide custom scope aside the ones predefined in 'scopes' array. In this case a new option named 'custom' appears in the list and once chosen a prompt appears to provide custom scope
jiraOptionalfalseIf this is set to true, you can leave the JIRA field blank.
jiraLocation"pre-description"Changes position of JIRA ID. Options: pre-type, pre-description, post-description, post-body
jiraPrepend""Prepends JIRA ID with an optional decorator. e.g.: [DAZ-1234
jiraAppend""Appends JIRA ID with an optional decorator. e.g.: DAZ-1234]
exclamationMarkfalseOn breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1.

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.

FAQs

Package last updated on 05 May 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc