JSON Schema definitions of the release-notes specification - an easy to use, human readable and machine processable schema for release notes.
npm install @release-notes/schema
The goal of this repository is to implement JSON Schema Definitions
of the Release Notes Specification.
The following schemas are defined:
* ReleaseNotes
* Release
* ModificationList
* Modification
* TagList
* Tag
$ npm i -S @release-notes/schema
``js
const ReleaseNotesSchema = require('@release-notes/schema');
console.info(
'Required fields of release notes: %s',
ReleaseNotesSchema.ReleaseNotes.required.join(', ')
);
``
The Release Notes project consists of the following repositories:
- Release Notes Hub
- Release Notes CLI Tool
- Release Notes Node.js lib
- Release Notes Specification
- Release Notes JSON-Schema Definitions
---
The files in this archive are released under MIT license.
You can find a copy of this license in LICENSE.