conventional-changelog-writer

conventional-changelog-writer

Write logs based on conventional commits and templates.

Install

# pnpm
pnpm add conventional-changelog-writer
# yarn
yarn add conventional-changelog-writer
# npm
npm i conventional-changelog-writer

Usage

import { writeChangelogString } from 'conventional-changelog-writer'

// commits parsed by conventional-commits-parser
const commits = [/* ... */]
const context = {
  version: '1.0.0',
  host: 'https://github.com',
  owner: 'conventional-changelog',
  repository: 'conventional-changelog'
}

console.log(await writeChangelogString(commits, context))
/*
## 1.0.0 (2015-05-29)

### Features

* **ng-list:** Allow custom separator ([13f3160](https://github.com/...))
...
*/

Documentation

For streams and async iterables helpers, context and options reference, customization guide, and CLI usage, visit the documentation website.

License

MIT Steve Mao