Skip to content
This repository has been archived by the owner on Oct 22, 2023. It is now read-only.

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

License

Notifications You must be signed in to change notification settings

release-notes/changelog-parser

Repository files navigation

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.

About

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

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published