This plugin enables and configures semantic releases, codename generation, integration tests, synced dotfiles and common githooks for all hoodie packages.
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-hoodie --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-release-hoodie');
This task comes with a setup script. You should be good to go after running this.
./node_modules/.bin/setup
In your project's Gruntfile, add a section named release
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
release: {}
})
Type: Object
Default value:
bump: {
commitMessage: 'chore(release): v%VERSION%',
files: ['package.json', 'bower.json'],
commitFiles: [
'package.json',
'bower.json',
'CHANGELOG.md',
'dist/*'
],
pushTo: 'origin master'
}
The options object that gets forwarded to the grunt-bump task.
Type: Array<String>
Default value: ['codename', 'changelog']
A list of tasks that prepare files for the release commit.
Type: Boolean
Default value: true
Whether to pull in the default dotfiles or not.
In your project's Gruntfile, add a section named dotfiles
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
dotfiles: {}
})
Type: String
Default value: '.hoodie/'
The location of where to cache the dotfiles inside your homefolder.
Type: Array
Default value: 'dotfiles'
In which subfolder of options.namespace
to clone the repo.
Type: String
Default value: 'https://github.com/hoodiehq/hoodie-dotfiles.git'
The repo where the dotfiles are.
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.
Copyright (c) 2014 Stephan Bönnemann. Licensed under the Apache License 2.0 license.