🌜
🌞
cz-conventional-changelog

cz-conventional-changelog

v3.3.0

Commitizen adapter following the conventional-changelog format.

npm install cz-conventional-changelog

README

cz-conventional-changelog

Greenkeeper badge

Status: npm version npm downloads Build Status

Part of the commitizen family. Prompts for conventional changelog standard.

Configuration

package.json

Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key.

{
// ...  default values
    "config": {
        "commitizen": {
            "path": "./node_modules/cz-conventional-changelog",
            "disableScopeLowerCase": false,
            "disableSubjectLowerCase": false,
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "types": {
              ...
              "feat": {
                "description": "A new feature",
                "title": "Features"
              },
              ...
            }
        }
    }
// ...
}

Environment variables

The following environment varibles can be used to override any default configuration or package.json based configuration.

  • CZ_TYPE = defaultType
  • CZ_SCOPE = defaultScope
  • CZ_SUBJECT = defaultSubject
  • CZ_BODY = defaultBody
  • CZ_MAX_HEADER_WIDTH = maxHeaderWidth
  • CZ_MAX_LINE_WIDTH = maxLineWidth

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 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.

Release Notes

3.3.0
By Commitizen Bot • Published on August 26, 2020

3.3.0 (2020-08-26)

Features

  • engine: add support for disableSubjectLowerCase (df66875)
3.2.1
By Commitizen Bot • Published on August 24, 2020

3.2.1 (2020-08-24)

Bug Fixes

  • Correct typo in JSON (58df4d1)
  • Wrap updateTypes in packageRules (0f6dfbf)
3.2.0
By Commitizen Bot • Published on May 4, 2020

3.2.0 (2020-05-04)

Features

3.1.1
By Commitizen Bot • Published on May 4, 2020

3.1.1 (2020-05-04)

Bug Fixes

  • defaultValues: Added fallback for optional default values (#99) (2aae317)
3.1.0
By Commitizen Bot • Published on January 28, 2020

3.1.0 (2020-01-28)

Features

  • engine: add support for disableScopeLowerCase (#96) (e7bd546)
3.0.3
By Commitizen Bot • Published on January 28, 2020

3.0.3 (2020-01-28)

Bug Fixes

  • Update conventional-commit-types to the latest version 🚀 (#105) (5a371c1)
3.0.2
By Commitizen Bot • Published on July 21, 2019

3.0.2 (2019-07-21)

Bug Fixes

  • config-loader: captured the direct dependency on commitizen for the use of the config loader (#90) (4b23bbc), closes #89
3.0.1
By Commitizen Bot • Published on July 19, 2019

3.0.1 (2019-07-19)

Bug Fixes

3.0.0
By Commitizen Bot • Published on July 19, 2019

3.0.0 (2019-07-19)

Bug Fixes

Features

  • add default values to options (#69) (65d6a9f)
  • implement configuration through package.json (#75) (3398c02)

BREAKING CHANGES

  • Node 10 is LTS so please upgrade to it.
2.1.0
By Commitizen Bot • Published on October 27, 2017

<a name"2.1.0">

2.1.0 (2017-10-27)

Features

  • prompt: add confirmation fields + edit for clarity (#58) (d40ac2c5)

General

License
MIT
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
629
Community Interest
940
Number of Forks
422

Maintenance

Commits
10/219/22020
Last Commit
Open Issues
31
Closed Issues
33
Open Pull Requests
19
Closed Pull Requests
65

Versions

Versions Released
10/219/2201
Latest Version Released
Aug 26, 2020
Current Tags
latest3.3.0

Contributors

greenkeeper[bot]
greenkeeper[bot]
Commits: 11
jimthedev
jimthedev
Commits: 5
kentcdodds
kentcdodds
Commits: 3
dmwelch
dmwelch
Commits: 3
travi
travi
Commits: 2
iainjreid
iainjreid
Commits: 2
tomkaar
tomkaar
Commits: 1
AndersDJohnson
AndersDJohnson
Commits: 1
ivikash
ivikash
Commits: 1
Rayman
Rayman
Commits: 1
jacobq
jacobq
Commits: 1
adjohnson916
adjohnson916
Commits: 1
zoffyzhang
zoffyzhang
Commits: 1
petermetz
petermetz
Commits: 1
renovate[bot]
renovate[bot]
Commits: 1