lerna-changelog

lerna-changelog
==============================================================================

[![TravisCI Build Status][travis-badge]][travis-badge-url]
[![Latest NPM release][npm-badge]][npm-badge-url]

[npm-badge]: https://img.shields.io/npm/v/lerna-changelog.svg
[npm-badge-url]: https://www.npmjs.com/package/lerna-changelog
[travis-badge]: https://img.shields.io/travis/lerna/lerna-changelog/master.svg
[travis-badge-url]: https://travis-ci.org/lerna/lerna-changelog

PR-based changelog generator with monorepo support

Usage
------------------------------------------------------------------------------

``bash
npx lerna-changelog
`

`md


Unreleased (2018-05-24)

#### :bug: Bug Fix
* #198 Avoid an infinite loop (@helpful-hacker)

#### :house: Internal
* #183 Standardize error messages (@careful-coder)

#### Commiters: 2
- Helpful Hacker (@helpful-hacker)
- @careful-coder
`

By default lerna-changelog will show all pull requests that have been merged
since the latest tagged commit in the repository. That is however only true for
pull requests with certain labels applied. The labels that are supported by
default are:

- breaking (:boom: Breaking Change)
- enhancement (:rocket: Enhancement)
- bug (:bug: Bug Fix)
- documentation (:memo: Documentation)
- internal (:house: Internal)

You can also use the --from and --to options to view a different
range of pull requests:

`bash
npx lerna-changelog --from=v1.0.0 --to=v2.0.0
`

$3

If you have a packages folder and your projects in subfolders of that folder lerna-changelog will detect it and include the package names in the changelog for the relevant changes.

$3

Since lerna-changelog interacts with the GitHub API you may run into rate
limiting issues which can be resolved by supplying a "personal access token":

`
export GITHUB_AUTH="..."
`

You'll need a personal access token
for the GitHub API with the repo scope for private repositories or just
public_repo scope for public repositories.


Configuration
------------------------------------------------------------------------------

You can configure lerna-changelog in various ways. The easiest way is by
adding a changelog key to the package.json file of your project:

`json5
{
// ...
"changelog": {
"labels": {
"feature": "New Feature",
"bug": "Bug Fix"
}
}
}
`

The supported options are:

- repo: Your "org/repo" on GitHub
(automatically inferred from the package.json file)

- nextVersion: Title for unreleased commits
(e.g. Unreleased)

- labels: GitHub PR labels mapped to changelog section headers

- ignoreCommitters: List of committers to ignore (exact or partial match).
Useful for example to ignore commits from bots.

- cacheDir: Path to a GitHub API response cache to avoid throttling
(e.g. .changelog)


License
------------------------------------------------------------------------------

lerna-changelog` is released under the MIT License.