asini-changelog
v1.3.0
Published
Generate a changelog for an Asini repo
Downloads
8
Readme
Asini Changelog
Generate a changelog for a asini 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 asini-changelog
Configure:
$ git diff asini.json
...
{
+ "changelog": {
+ "repo": "my-org/my-repo",
+ "labels": {
+ "bug": "Bug fix",
+ "cleanup": "Housekeeping"
+ },
+ "cacheDir": ".changelog"
+ },
"asini": "x.x.x",
"version": "0.2.11"
}
Authenticate:
$ export GITHUB_AUTH="..."
Run:
$ asini-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 GitHubcacheDir
[optional]: A place to stash GitHub API responses to avoid throttlinglabels
: GitHub issue/PR labels mapped to changelog section headers