This plugin creates a release on github and uploads your corresponding assets. It depends heavily on the node.js wrapper for GitHub API.
This plugin requires Grunt ~1.0.0
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-github-releaser2 --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-github-releaser2');
In your project's Gruntfile, add a section named github_releaser2
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
github_releaser2: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
});
Type: String
Default value: null
Your GitHub repository url segment (e.g. sualko/grunt-github-releaser2
).
Type: Object
Default value: {}
Any authentication option from node-github.
Type: Object
Default value: {}
Type: String
Default value: NPM VERSION FIELD
String of the tag.
Type: String
Default value: default branch
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA.
Type: String
Default value: ``
Name (headline) of the release.
Type: String
Default value: ``
Release description.
Type: Boolean
Default value: false
true
to create a draft (unpublished) release, false
to create a published one.
Type: Boolean
Default value: false
true
to identify the release as a prerelease. false
to identify the release as a full release.
grunt.initConfig({
github_releaser2: {
options: {
repository: 'sualko/grunt-github-releaser2',
authentication: {
type: 'token',
token: 'YOUR_TOKEN'
}
}
},
});
grunt.initConfig({
github: grunt.file.readJSON('.github.json'),
github_releaser2: {
options: {
repository: 'sualko/grunt-github-releaser2',
authentication: {
type: 'token',
token: '<%= github.token %>'
},
release: {
body: 'Foo bar'
}
},
release: {
src: ['release.zip']
},
prerelease: {
options: {
release: {
prerelease: true
}
}
src: ['prerelease.zip']
}
}
});
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Please see the CHANGELOG.md.