https://github.com/commitizen/cz-conventional-changelog

A commitizen adapter for the angular preset of https://github.com/conventional-changelog/conventional-changelog
https://github.com/commitizen/cz-conventional-changelog

command-line commit-hooks commitizen commitizen-adapter git javascript

Last synced: 4 days ago
JSON representation

A commitizen adapter for the angular preset of https://github.com/conventional-changelog/conventional-changelog

• Host: GitHub
• URL: https://github.com/commitizen/cz-conventional-changelog
• Owner: commitizen
• License: mit
• Created: 2015-04-20T01:37:25.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-09-30T13:46:48.000Z (4 months ago)
• Last Synced: 2025-01-06T05:05:05.597Z (20 days ago)
• Topics: command-line, commit-hooks, commitizen, commitizen-adapter, git, javascript
• Language: JavaScript
• Homepage:
• Size: 1.74 MB
• Stars: 771
• Watchers: 10
• Forks: 439
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - cz-conventional-changelog - changelog/conventional-changelog | commitizen | 525 | (JavaScript)
• stars - cz-conventional-changelog - changelog/conventional-changelog | commitizen | 771 | (JavaScript)
• stars - cz-conventional-changelog - changelog/conventional-changelog | commitizen | 770 | (JavaScript)

README

        
# cz-conventional-changelog

[![Greenkeeper badge](https://badges.greenkeeper.io/commitizen/cz-conventional-changelog.svg)](https://greenkeeper.io/)

Status:

[![npm version](https://img.shields.io/npm/v/cz-conventional-changelog.svg?style=flat-square)](https://www.npmjs.org/package/cz-conventional-changelog)

[![npm downloads](https://img.shields.io/npm/dm/cz-conventional-changelog.svg?style=flat-square)](http://npm-stat.com/charts.html?package=cz-conventional-changelog&from=2015-08-01)

[![Build Status](https://img.shields.io/travis/commitizen/cz-conventional-changelog.svg?style=flat-square)](https://travis-ci.org/commitizen/cz-conventional-changelog)

Part of the [commitizen](https://github.com/commitizen/cz-cli) family. Prompts for [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) standard.

## Configuration

### package.json

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

```json5

{

// ...  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 variables 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](https://github.com/conventional-changelog/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.