@tophat/conventional-changelog-config
Top Hat's shareable configuration for conventional-changelog
Installation
Using Yarn:
yarn add @tophat/conventional-changelog-config --dev
Or using npm:
npm install @tophat/conventional-changelog-config --save-dev
Usage
Using Lerna:
lerna publish --skip-git --conventional-commits --changelog-preset @tophat/conventional-changelog-config --yes
Note: The lerna above should be the path to your Lerna executable if
Lerna is not installed globally.
Convention
The changelog uses the commit message format from the Angular Convention.
Included Commit Types
The full list of commit types are listed here. However, only the following types will be included in the changelog generation.
feat:
This commit is a new feature.
Example:
feat: add bold and italics options to formatting toolbar
In the changelog, this may look like:
1.1.0 (2019-04-26)
------------------
Features
- add bold and italics options to formatting toolbar (#100) (1ab23c4)
fix
This commit is a bug fix.
Example:
fix: adjust page preview height
In the changelog, this may look like:
1.1.1 (2019-04-26)
------------------
Bug Fixes
- adjust page preview height (#101) (z987y65)
perf
This commit makes performance improvements.
Example:
perf: reduce number of re-renders in the preview
In the changelog, this may look like:
1.1.2 (2019-04-26)
------------------
Performance Improvements
- reduce number of re-renders in the preview (#103) (m56np7)
revert
This commit reverts a specified commit.
Example:
revert: "feat: add bold and italics options to formatting toolbar (#100)"
This reverts commit 1ab23c4.
In the changelog, this may look like:
1.1.3 (2019-04-26)
------------------
Reverts
- add bold and italics options to formatting toolbar (1ab23c4)
Breaking Changes
This commit indicates that there is some major change that is non-backwards compatible and requires consumers to take action.
In the changelog, this may look like:
2.0.0 (2019-04-26)
------------------
Breaking Changes
- the formatter v2 endpoint has been deprecated (q12rs34)