| Title | Release Notes Node |
|---|---|
| Specification | Release Notes Draft 0.2.0 |
| Author | Alrik Zachert |
| License | MIT |
The goal of this repository is to provide a reference implementation of the Release Notes Specification.
$ npm i @release-notes/node
const ReleaseNotesLoader = require('@release-notes/node/lib/ReleaseNotesLoader'); const loader = new ReleaseNotesLoader(); loader.readReleaseNotesFile('./release-notes.yml', (err, releaseNotes) => { if (err) { if (err.isValidationError) { return void console.error( 'Could not load release notes. Validation failed: ', err.validationErrors ); } return void console.error( 'Could not load release-notes.yml', err ); } console.info( `Successfully loaded release notes ${releaseNotes.title}` ); });
The files in this archive are released under MIT license. You can find a copy of this license in LICENSE.