@dgc-org/cz-conventional-changelog-for-jira

    1.4.2 • Public • Published

    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 @dgc-org/cz-conventional-changelog-for-jira

    and then add the following to package.json:

    {
        "scripts": {
            "commit": "git-cz"
        },
        "config": {
            "commitizen": {
                "path": "./node_modules/@dgc-org/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 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_JIRA_HOST jiraHost undefined The hostname of the Jira instance to use when fetching labels and ticket IDs.
    CZ_JIRA_USER jiraUser undefined The email address of the Jira user to authenticate with when fetching labels and ticket IDs.
    CZ_JIRA_TOKEN jiraToken undefined A Jira API token to authenticate with when fetching labels and ticket IDs.
    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.
    scopes undefined A 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_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.
    CZ_JIRA_OPTIONAL jiraOptional false If this is set to true, you can leave the JIRA field blank.
    CZ_JIRA_PREFIX jiraPrefix "ITCORE" If this is set it will be will be displayed as the default JIRA ticket prefix.

    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("@dgc-org/cz-conventional-changelog-for-jira/configurable");
    // You can do this optionally if you want to extend the commit types
    const defaultTypes = require("@dgc-org/cz-conventional-changelog-for-jira/commit-types");
    
    module.exports = custom({
        types: {
            ...defaultTypes,
            perf: {
                description: "Improvements that will make your code perform better",
                title: "Performance"
            }
        },
        skipScope: false,
        scopes: ["myScope1", "myScope2"]
    });

    ./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:

    Key Default Description
    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.
    jiraHost undefined The hostname of the Jira instance to use when fetching labels and ticket IDs.
    jiraUser undefined The email address of the Jira user to authenticate with when fetching labels and ticket IDs.
    jiraToken undefined A Jira API token to authenticate with when fetching labels and ticket IDs.
    maxHeaderWidth 72 This limits how long a commit message head can be.
    minHeaderWidth 2 This limits how short a commit message can be.
    maxLineWidth 100 Commit message bodies are automatically wrapped. This decides how long the lines will be.
    skipScope true If scope should be used in commit messages.
    defaultType undefined The default type.
    defaultScope undefined The default scope.
    defaultSubject undefined A default subject.
    defaultBody undefined A default body.
    defaultIssues undefined A default issue.
    jiraPrefix 'ITCORE' The default JIRA ticket prefix that will be displayed.
    types ./commit-types.js A list (JS Object) of supported commit types.
    scopes undefined A 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'.
    jiraOptional false If this is set to true, you can leave the JIRA field blank.

    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.

    Install

    npm i @dgc-org/cz-conventional-changelog-for-jira

    DownloadsWeekly Downloads

    10

    Version

    1.4.2

    License

    MIT

    Unpacked Size

    31.5 kB

    Total Files

    8

    Last publish

    Collaborators

    • pldreyer
    • linkjp
    • dede67
    • lednerb
    • itspngu
    • dgc-bot
    • memo21