grunt-release-hg-bower

grunt-release-hg-bower

This plugin automates the release process for mercurial projects that are being packaged using bower.

Getting Started

This plugin requires Grunt ~0.4.5

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-hg-bower --save-dev

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

grunt.loadNpmTasks('grunt-release-hg-bower');

The "bower_release" task

Overview

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

grunt.initConfig({
  bower_release: {
    options: {
        githubEndpoint: "https://github.com/<your_github_account_name>/<your_release_repo_name>.git"
    },
    you_target_here: {
        src: [
            //your specific files to be released here...
            '**/*.js',
            'README.md'
        ]
    }
  },
});

Options

options.separator

Type: String Default value: ', '

A string value that is used to do something with whatever.

options.punctuation

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Default Options

Here are the default options.

grunt.initConfig({
  bower_release: {
    options: {
        githubEndpoint: "https://github.com/<your_github_account_name>/<your_release_repo_name>.git",
        stagingDirectoryName: "__glueGruntStaging",
        ticketSystem: undefined
    },
    you_target_here: {
        src: [
            //your specific files to be released here...
        ]
    }
  },
});

Fogbugz Integration

In this example, we are turning on the fogbugz integration. If you then specify case(s) in your commit message the bower release will contain links to those cases in its commit message. Here is the format used to match cases in the commit message '/case[s]?.{1}\s*(?:\W*([0-9]+))*/ig'

grunt.initConfig({
  bower_release: {
    options: {
        githubEndpoint: "https://github.com/<your_github_account_name>/<your_release_repo_name>.git",
        ticketSystem: 'fogbugz'
    },
    you_target_here: {
        src: [
            //your specific files to be released here...
        ]
    }
  },
});

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.

Release History

Version 1.0.0 initial release supports releasing Hg repos to bower using the version information from the commit message. It also supports fogbugz case linking if specified in the commit message.