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 before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
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:
grunt;
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()
.
grunt;
Your release notes should be in a json file, formatted like this:
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