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

Latest commit

 

History

History
53 lines (40 loc) · 1.71 KB

README.md

File metadata and controls

53 lines (40 loc) · 1.71 KB

Release Notes Node

Subscribe to Release Notes NPM Package Build Status MIT license

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.

Installation

$ npm i @release-notes/node

Load A Release Notes File

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}`
  );
});

LICENSE

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