Skip to content

2099/grunt-github-release-notes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

grunt-github-release-notes

npm version

Grunt module to publish release notes based on commits between the last two tags. This module is using github-release-notes.

Getting Started

This plugin requires Grunt ~0.4.5

npm install grunt-github-release-notes --save-dev

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

grunt.loadNpmTasks('grunt-github-release-notes');

The "release" task

Overview

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;

Optionals

There are optional arguments such as:

  • draft: true To set the release as a draft. Default: false
  • prerelease: true To set the release as a prerelease. Default: false
  • prefix: 'v' Add a prefix to the tag version e.g. v1.0.1.
  • force: true Doesn't fail the task if the task presents any errors. Default: false
  • includeMessages: merges/commits/all used to filter the messages added to the release notes. Default: commits

About

Grunt module to publish release notes based on commits between the last two tags.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 100.0%