The changelog parser reads changelog.md files and derivatives and converts them to release notes objects with a standardized schema.
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
index.js
package.json
release-notes.yml
yarn.lock

README.md

Release Notes Changelog Parser

Subscribe to Release Notes NPM Package MIT license

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.