Repository files navigation

PR-based changelog generator with monorepo support

npx lerna-changelog

##Unreleased (2018-05-24)####:bug: Bug Fix*[#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))####:house: Internal*[#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))####Commiters: 2- Helpful Hacker ([@helpful-hacker](https://github.com/helpful-hacker))-[@careful-coder](https://github.com/careful-coder)

By defaultlerna-changelog will show all pull requests that have been mergedsince the latest tagged commit in the repository. That is however only true forpull requests with certain labels applied. The labels that are supported bydefault 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 differentrange of pull requests:

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

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

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

export GITHUB_AUTH="..."

You'll need apersonal access tokenfor the GitHub API with therepo scope for private repositories or justpublic_repo scope for public repositories.

You can configurelerna-changelog in various ways. The easiest way is byadding achangelog key to thepackage.json file of your project:

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

The supported options are:

• repo: Your "org/repo" on GitHub(automatically inferred from thepackage.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)

lerna-changelog is released under theMIT License.