grunt-release-hoodie

grunt-release-hoodie

Automatically configures the hoodie release process.

Using this plugin it is possible to release a new version with just grunt release.

This will

• will determine the correct semantic version to use, based on changes made
• only release code that doesn't fail it's tests
• pull in the latest hoodie-dotfiles
• trigger a release preparation that generates a changelog as well as a codename on (Travis)CI
• publishes the new version to npm and GitHub releases

Here is an example release.

Getting Started

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

The "release" task

Overview

In your project's Gruntfile, add a section named release to the data object passed into grunt.initConfig().

grunt.initConfig({
  release: {}
})

Options

options.bump

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.

options.tasks

Type: Array<String> Default value: ['codename', 'changelog']

A list of tasks that prepare files for the release commit.

options.dotfiles

Type: Boolean Default value: true

Whether to pull in the default dotfiles or not.

The "dotfiles" task

Overview

In your project's Gruntfile, add a section named dotfiles to the data object passed into grunt.initConfig().

grunt.initConfig({
  dotfiles: {}
})

Options

options.namespace

Type: String Default value: '.hoodie/'

The location of where to cache the dotfiles inside your homefolder.

options.dotfiles

Type: Array Default value: 'dotfiles'

In which subfolder of options.namespace to clone the repo.

options.repo

Type: String Default value: 'https://github.com/hoodiehq/hoodie-dotfiles.git'

The repo where the dotfiles are.

Contributing

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.

License

Copyright (c) 2014 Stephan Bönnemann. Licensed under the Apache License 2.0 license.