# generate_release_notes

> This generates two files ```notes.html``` a view of your change logs and readme ```changelogs.json``` the github dump

Latest version **1.3.0** (published 2016-03-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install generate_release_notes
pnpm add generate_release_notes
yarn add generate_release_notes
bun add generate_release_notes
```

Provides the command `junit-viewer`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2016-03-08 |
| First published | 2016-02-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | BBC |
| Maintainers | lukejpreston, subsidel |

## Links

- npm: https://www.npmjs.com/package/generate_release_notes
- Repository: https://github.com/bbc/generate_release_notes
- Homepage: https://github.com/bbc/generate_release_notes#readme
- Issues: https://github.com/bbc/generate_release_notes/issues
- npm.io page: https://npm.io/package/generate_release_notes

## Dependencies (3)

- [marked](https://npm.io/package/marked.md) ^0.3.5
- [mustache](https://npm.io/package/mustache.md) ^2.2.1
- [octonode](https://npm.io/package/octonode.md) ^0.7.4

## Recent versions

- 1.3.0 (latest) — 2016-03-08
- 1.2.4 — 2016-02-19
- 1.2.3 — 2016-02-18
- 1.2.2 — 2016-02-18
- 1.2.1 — 2016-02-18
- 1.2.0 — 2016-02-18
- 1.1.0 — 2016-02-18
- 1.0.0 — 2016-02-18

## README

# Generate Release Notes

This generates two files
```notes.html``` a view of your change logs and readme
```changelogs.json``` the github dump

## CLI Usage

Install using

```npm i -g generate_release_notes```

You need the following param

* ```--repo=:owner/:repo```

The following params are optional

* ```--save-to=folder_location``` saves notes.html and changelog.json to this folder, defaults to ```./```
* ```--token=xxx``` the github oatuh token
* ```--from-tag-name=x.x.x.x.x.x...``` assumption it is
a versioned number
* ```--last-releases=X``` gets the last X releases
* ```--readme-location=file_location``` this will be in the top of notes.html, will not be present when not given
* ```--style-sheet-location=file_location``` adds style sheet for notes.html, will still look like readme
* ```--usage``` or ```--help``` exits and displays this message

## Node Usage
Install using

```npm i --save-dev generate_release_notes```

```
var generate = require('generate_release_notes');

var options = {
    'repo':':owner/:repo',
    'save-to':'folder_location',
    'token':'xxx',
    'readme-location':'file_location',
    'style-sheet-location':'file_location',
    'from-tag-name':'x.x.x.x.x.x...',
    'last-releases': X,
    'callback': function(data) {
        console.log(data.notes) // the html string
        console.log(data.changelogs) // the json string
    }
}

generate.create(options);
```

In this case you will need the callback because of the call to github

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