grunt-git-dist

Release using git

Getting Started

This plugin requires Grunt ~0.4.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-git-dist --save-dev

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

grunt.loadNpmTasks('grunt-git-dist');

The "git-dist" task

Overview

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

grunt.initConfig({
  "git-dist" : {
    "options" : {
      "url" : "<%= pkg.repository.url %>",
      "branch" : "build/2.x",
      "dir" : "<%= build.dist %>",
      "paths" : [ "path/to/dir", "path/to/file.ext" ],
      "message" : "<%= pkg.name %> - <%= pkg.version %>",
      "tag" : "<%= pkg.version %>",
      "config" : {
          "user.name" : "<%= pkg.author.name %>",
          "user.email" : "<%= pkg.author.email %>",
      },
      "empty" : true
    },
    "your_target": {
      // Target-specific file lists and/or options go here.
    },
  },
})

Note that since this is a multi-task you have to have at least one target defined for git-dist (otherwise the task won't run)

Options

options.url

Type: String
Default value: undefined

A string value that is used to select what repository to clone. If empty the current repository will be used.

options.branch

Type: String
Default value: undefined

A string value that is used to select what branch to clone.

options.dir

Type: String
Default value: undefined

A string value that is used to select what dir to clone to.

options.paths

Type: Array
Default value: undefined

An array value that is used to select wich files to add.

options.message

Type: String
Default value: undefined

A string value that is used as a commit/tag message.

options.config

Type: Object Default value: undefined

An object value that is used to configure the clone.

options.tag

Type: String
Default value: undefined

A string value that is used as the tag name.

options.empty

Type: Boolean
Default value: undefined

A boolean value that is used to allow empty commits.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Lint and test your code using Grunt.

Release History

0.4.0 - Added add phase. Regular add removed from commit phase
0.3.1 - Added standardized support for CLI parameters
0.3.0 - Added init and tag phase. 0.2.3 - Removed configure phase. Instead we configure during clone
0.2.2 - Added support for empty
0.2.1 - Realized that we can support URL, so added it back
0.2.0 - Remove support for URL as we always clone the local repository
0.1.1 - Fix so deleted files are tracked
0.1.0 - Initial release