conventional-changelog-chestnut

Introduce

A conventional-changelog log template

The reference toconventional-changelog-angular

Installation preparation

Make sure you install the dependent packages first

• commitizen
• cz-conventional-changelog
• conventional-changelog-cli

Install

1npm install conventional-changelog-chestnut --save-dev

Use

1{
2	"scripts": {
3		"changelog": "conventional-changelog -p chestnut -i CHANGELOG.md -s -r 0"
4	}
5}

Configuration

It needs to be in the project root directory create .chestnutlogrc file，A reference document is provided here

types

type: Array

The default parameter type is based on commitizen provide，According to the git commit message的type output the log

Array element Settings must contain the type and alias fields

The array must have at least one item, otherwise the default configuration is used

{
  "types": [
    {
      "type": "feat",
      "alias": "Features"
    }
  ]
}

authorName

type: Boolean, default: false

show the submitter

{
	"authorName": false
}

authorEmail

type: Boolean, default: false

show the Email of submitter

{
	"authorEmail": false
}

License

MIT © bnuephjx