Angular preset for conventional-changelog.
npm install conventional-changelog-angular[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[![Node version][node]][node-url]
[![Dependencies status][deps]][deps-url]
[![Install size][size]][size-url]
[![Build status][build]][build-url]
[![Coverage status][coverage]][coverage-url]
[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[package-url]: https://nodejs.org/api/esm.html
[npm]: https://img.shields.io/npm/v/conventional-changelog-angular.svg
[npm-url]: https://npmjs.com/package/conventional-changelog-angular
[node]: https://img.shields.io/node/v/conventional-changelog-angular.svg
[node-url]: https://nodejs.org
[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-angular
[deps-url]: https://libraries.io/npm/conventional-changelog-angular/tree
[size]: https://packagephobia.com/badge?p=conventional-changelog-angular
[size-url]: https://packagephobia.com/result?p=conventional-changelog-angular
[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master
conventional-changelog angular preset.
Issues with the convention itself should be reported on the Angular issue tracker.
``bash`yarn
yarn add -D conventional-changelog-angularpnpm
pnpm add -D conventional-changelog-angularnpm
npm i -D conventional-changelog-angular
Angular's commit message guidelines.
Appears under "Features" header, pencil subheader:
`
feat(pencil): add 'graphiteWidth' option
Appears under "Bug Fixes" header, graphite subheader, with a link to issue #28:
`
fix(graphite): stop graphite breaking when width < 0.1
Closes #28
`
Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
`
perf(pencil): remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
`
The following commit and commit 667ecc1 do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
`
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
`
A commit message consists of a header, body and footer. The header has a type, scope and subject:
`
The header is mandatory and the scope of the header is optional.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit , where the hash is the SHA of the commit being reverted.
If the prefix is feat, fix or perf, it will appear in the changelog. However if there is any BREAKING CHANGE, the commit will always appear in the changelog.
Other prefixes are up to your discretion. Suggested prefixes are build, ci, docs ,style, refactor, and test for non-changelog related tasks.
Details regarding these types can be found in the official Angular Contributing Guidelines.
The scope could be anything specifying place of the commit change. For example $location,$browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...
The subject contains succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* don't capitalize first letter
* no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes".
The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to
reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this document.
| Option | Description |
|--------|-------------|
| ignoreCommits | Regular expression to match and exclude commits from the changelog. Commits matching this pattern will be ignored. |