Grunt module to publish release notes based on commits between the last two tags. This module is using github-release-notes.
This plugin requires Grunt ~0.4.5
npm install grunt-github-release-notes --save-devOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-github-release-notes');In your project's Gruntfile, add a section named gren to the data object passed into grunt.initConfig().
token, username and repo are required.
gren: {
release: {
options: {
token: 'GITHUB_TOKEN',
username: 'GITHUB_USERNAME',
repo: 'GITHUB_REPO_NAME'
}
}
}To generate a github token, follow this link;
There are optional arguments such as:
draft: trueTo set the release as a draft. Default:falseprerelease: trueTo set the release as a prerelease. Default:falseprefix: 'v'Add a prefix to the tag versione.g. v1.0.1.force: trueDoesn't fail the task if the task presents any errors. Default:falseincludeMessages: merges/commits/allused to filter the messages added to the release notes. Default:commits