@ontra/cz-conventional-changelog-for-gitlab v1.0.3

cz-conventional-changelog-for-gitlab

⚠️ ⚠️ ⚠️ THIS IS A WIP. NOT SUITABLE FOR PRODUCTION ⚠️ ⚠️ ⚠️

Part of the commitizen family. Prompts for conventional changelog standard and also prompts for a mandatory GitLab issue.

Features

• Works seamlessly with semantic-release 🚀
• Automatically detects the GitLab issue from the branch name

Quickstart

Installation

npm install commitizen @ontra/cz-conventional-changelog-for-gitlab

and then add the following to package.json:

{
  "scripts": {
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/@ontra/cz-conventional-changelog-for-gitlab"
    }
  }
}

Usage

Configuration

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

GitLab Location Options

pre-type:

1234 type(scope): commit subject

pre-description:

type(scope): 1234 commit subject

post-description:

type(scope): commit subject 1234

post-body:

type(scope): commit subject

1234

type(scope): commit subject

this is a commit body

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

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.