# grunt-release-notes-to-readme

> A grunt plugin that will parse release notes from a JSON file into a readme.md file.

Latest version **0.1.0** (published 2017-09-13) · 0 weekly downloads

## Install

```sh
npm install grunt-release-notes-to-readme
pnpm add grunt-release-notes-to-readme
yarn add grunt-release-notes-to-readme
bun add grunt-release-notes-to-readme
```

## 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.1.0 |
| Published | 2017-09-13 |
| First published | 2017-09-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jordan Leven |
| Maintainers | jordanleven |
| Keywords | gruntplugin, release, notes, convert |

## Links

- npm: https://www.npmjs.com/package/grunt-release-notes-to-readme
- Repository: https://github.com/jordanleven/grunt-release-notes-to-readme
- Issues: https://github.com/jordanleven/grunt-release-notes-to-readme/issues
- npm.io page: https://npm.io/package/grunt-release-notes-to-readme

## Recent versions

- 0.1.0 (latest) — 2017-09-13

## README

# grunt-release-notes-to-readme

> A grunt plugin that will parse release notes from a JSON file into a readme.md file.

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-release-notes-to-readme --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-release-notes-to-readme');
```

## The "release_notes_to_readme" task

### Overview
In your project's Gruntfile, add a section named `convertNotes` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  convertNotes: {
      my_release_notes: {
          options: {
              package_json: 'package.json'
          },
          files: {
              'README.md' : 'release-notes-valid-json.json'
          }
      }
  }
});
```

Your release notes should be in a json file, formatted like this:

```json
{
    "1.1.0":{
        "release_description" : "Version 1.1 of Release Notes has some new features.",
        "release_date" : "2017-09-01 00:00:00",
        "release_notes" :[
            {
                "note_title"       : "All da features",
                "note_description" : null,
                "note_bullets"     :[
                    "<mark>Mark it up!</mark>"
                ]
            }
        ]
    },
    "1.0.0":{
        "release_description" : "Version 1.0 of Release Notes is a major release that includes a fun new way to view release notes for themes.",
        "release_date" : "2017-08-01 00:00:00",
        "release_notes" :[
            {
                "note_title"       : "Initial commit",
                "note_description" : "You can optionally include descriptions. Otherwise, omit it or make its value <code>null</code>",
                "note_bullets"     :[
                    "Supports <b>text</b> <i>styles</i>",
                    "And other stuff"
                ]
            },

            {
                "note_title"       : "More features!",
                "note_description" : null,
                "note_bullets"     :[
                    "Do what ya want"
                ]
            }
        ]
    }
}
```

### Options

#### options.package_json
Type: `String`
Default value: `package.json`

The path to your package.json file. If none is selected, it will assume the package.json file in your project directory.

## Release History
 * 2017-09-13   v0.1.0  Initial release

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