cz-conventional-changelog-lerna
v0.1.3
Published
cz-conventional-changelog with lerna support.
Downloads
33
Readme
cz-conventional-changelog-lerna
Add a line "affects" to commit.
Forked from cz-conventional-changelog. No dependence added. Just a little change. Tested with lerna@5
.
Lerna monorepo root package.json example:
{
"name": "root",
"private": true,
"workspaces": [
"packages/*"
],
"devDependencies": {
"commitizen": "^4.1.2",
"cz-conventional-changelog-lerna": "^0.1.0",
"lerna": "^5.0.0"
},
"scripts": {
"commit": "cz",
"commit-all": "git add . && cz"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog-lerna",
}
}
}
lerna.json
{
"packages": [
"packages/*"
],
"command": {
"version": {
"conventionalCommits": true
}
},
"version": "independent"
}
When execute lerna version
or lerna publish
, the changelog will be generated.
Follow is orginal documentation of cz-conventional-changelog.
cz-conventional-changelog
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 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 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.