release-notes / changelog-parser

The changelog parser reads changelog.md files and derivatives and converts them to release notes objects with a standardized schema.

Release Notes Changelog Parser

About

The changelog parser reads CHANGELOG.md files and derivatives and converts them to release notes objects with a standardized schema. This allows further processing of changelog files and provides an unified access to information on version and even atomic modification level.

Installation

$ yarn add @release-notes/changelog-parser
$ npm i --save @release-notes/changelog-parser

Usage

const changelogParser = require('@release-notes/changelog-parser');
const fs = require('fs');

const changelog = fs.readFileSync('./CHANGELOG.md');
const releaseNotes = changelogParser.parse(changelog);
const json = releaseNotes.toJSON();

The changelog parser returns an instance of ReleaseNotes.

---

LICENSE

The files in this archive are released under MIT license. You can find a copy of this license in LICENSE.

changelog-parser's Issues

Changelog Format Support

This issue keeps track of all the different changelog formats out there.

TODO: needs further classification and compatibility table.

• keep a changelog
• react
• angular
• owncloud client

Add support for parsing release titles

Treat the first line of an optional release description (if it's bold) as release title.

...
## 1.0.0 - 2017-12-18
**An awesome release title**
An awesome release description 

### Added
...

should result in

const releaseNotes = changelogParser.parse(changelog);
const release = releaseNotes.findReleaseByVersion('1.0.0');

release.title === 'An awesome release title'
release.description === 'An awesome release description'