release-it-custom-changelog
v1.0.4
Published
Changelog plugin for release-it
Downloads
7
Maintainers
Readme
Custom Changelog plugin for release-it
This plugin will provide the recommended bump to release-it, and update the changelog file (e.g. CHANGELOG.md
).
Table of Contents
Install
npm
npm install --save-dev release-it-custom-changelog
yarn
yarn add -D release-it-custom-changelog
Usage
In the release-it config, for example:
"plugins": {
"release-it-custom-changelog": {
"infile": "CHANGELOG.md",
"fileHeader": {
"title": "# Changelog\n\n",
"description": "A string to be used as the main header section of the CHANGELOG.\n",
},
"withEmoji": true,
"language": "zh-CN",
"showAuthor": true,
"showEmail": false,
"parserOpts": "...",
"bump":"..."
}
}
Options
The Options description.
infile
Type: string
Default: ``
If ’‘
or undefined
, will not be written to the log file
fileHeader
Type: object
Default: { "title": "# Changelog\n\n", "description": "A string to be used as the main header section of the CHANGELOG.\n", }
whitEmoji
Type: boolean
Default: true
If false
, There will be no emoji before commit type
language
Type: string
Default: zh-CN
Only en-US
and zh-CN
showAuthor
Type: boolean
Default: false
If true
, will show commit author
showEmail
Type: boolean
Default: false
If true
, will show commit email
parserOpts
See the conventional-commits-parser docs.
bump
See the conventional-recommended-bump docs.