lerna-changelog's Introduction

Lerna Changelog

Generate a changelog for a lerna monorepo.

Based on @hzoo's long-lived PR for lerna changelog.

Uses github PR/Issue names categorized by labels with configurable headings.

Usage

Install:

$ npm install -g lerna-changelog

Configure:

$ git diff lerna.json
...
 {
+  "changelog": {
+    "repo": "my-org/my-repo",
+    "labels": {
+      "bug": "Bug fix",
+      "cleanup": "Housekeeping"
+    },
+    "cacheDir": ".changelog"
+  },
   "lerna": "2.0.0-beta.9",
   "version": "0.2.11"
 }

Authenticate:

$ export GITHUB_AUTH="..."

Run:

$ lerna-changelog

## Unreleased (2016-05-24)

#### Bug fix
* `my-package-a`, `my-package-b`
  * [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop. ([@helpful-hacker](https://github.com/helpful-hacker))

#### Housekeeping
* `my-package-c`
  * [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages. ([@careful-coder](https://github.com/careful-coder))

#### Commiters: 2
- helpful-hacker
- careful-coder

Copypasta. You're done!

GitHub Auth

You'll need a GitHub API personal access token.

Configuration

repo: Your "org/repo" on GitHub
cacheDir [optional]: A place to stash GitHub API responses to avoid throttling
labels: GitHub issue/PR labels mapped to changelog section headers
ignoreCommitters [optional]: list of commiters to ignore (exact or partial match). Useful for example to ignore commits from bot agents

CLI

$ lerna-changelog
Usage: lerna-changelog [options]

Options:
  --tag-from  A git tag that determines the lower bound of the range of commits
              (defaults to last available)                              [string]
  --tag-to    A git tag that determines the upper bound of the range of commits
                                                                        [string]
  --version   Show version number                                      [boolean]
  --help      Show help                                                [boolean]

Examples:
  lerna-changelog                           create a changelog for the changes
                                            after the latest available tag
  lerna-changelog --tag-from 0.1.0          create a changelog for the changes
  --tag-to 0.3.0                            in all tags within the given range

Recommend Projects