# @release-notes/schema

> JSON Schema definitions of the release-notes specification - an easy to use, human readable and machine processable schema for release notes.

Latest version **0.2.0** (published 2017-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @release-notes/schema
pnpm add @release-notes/schema
yarn add @release-notes/schema
bun add @release-notes/schema
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2017-10-30 |
| First published | 2017-07-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Alrik Zachert |
| Maintainers | a-z |
| Keywords | release notes, release-notes, releasenotes, release, notes, changelog, json schema, schema |

## Links

- npm: https://www.npmjs.com/package/@release-notes/schema
- Repository: https://github.com/release-notes/release-notes-schema
- Homepage: https://github.com/release-notes
- Issues: https://github.com/release-notes/release-notes-schema/issues
- npm.io page: https://npm.io/package/@release-notes/schema

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.2.0 (latest) — 2017-10-30
- 0.1.0 — 2017-07-07

## README

# Release Notes Schema

[![Subscribe to Release Notes](https://release-notes.com/badges/v1.svg)](https://release-notes.com/@release-notes/release-notes-schema)
[![NPM Package](https://img.shields.io/npm/v/@release-notes/schema.svg)](https://www.npmjs.com/package/@release-notes/schema)
[![MIT license](https://img.shields.io/github/license/release-notes/release-notes-schema.svg)](LICENSE)

# About

The goal of this repository is to implement [JSON Schema Definitions](https://trac.tools.ietf.org/html/draft-wright-json-schema-validation-01)
of the [Release Notes Specification](https://github.com/release-notes/release-notes-spec).

The following schemas are defined:

* [ReleaseNotes](definitions/release-notes.json)
* [Release](definitions/release.json)
* [ModificationList](definitions/modification-list.json)
* [Modification](definitions/modification.json)
* [TagList](definitions/tag-list.json)
* [Tag](definitions/tag.json)

## Installation

`$ npm i -S @release-notes/schema`

## Usage

```js
const ReleaseNotesSchema = require('@release-notes/schema');

console.info(
  'Required fields of release notes: %s',
  ReleaseNotesSchema.ReleaseNotes.required.join(', ')
);
```

## Project Repositories

The Release Notes project consists of the following repositories:
   
- [Release Notes Hub](https://github.com/release-notes/release-notes-hub)
- [Release Notes CLI Tool](https://github.com/release-notes/release-notes-cli)
- [Release Notes Node.js lib](https://github.com/release-notes/release-notes-node)
- [Release Notes Specification](https://github.com/release-notes/release-notes-spec)
- [Release Notes JSON-Schema Definitions](https://github.com/release-notes/release-notes-schema)

---

### LICENSE

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

---
_Source: https://npm.io/package/@release-notes/schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._