grunt-batch-git-clone

Clones multiple git repos into the specified folders.

This plugin enables you to install and setup multiple git repos into a specified folder structure. You can then install npm and bower dependencies or run commands on each folder such as grunt build.

Help

If you need any help, or want to request a feature just create an issue on this repo, I am actively checking and should be able to assist. Feel free to submit pull requests too !! :)

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-batch-git-clone --save-dev

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

grunt.loadNpmTasks('grunt-batch-git-clone');

The "batch_git_clone" task

Overview

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

grunt.initConfig({
  batch_git_clone: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.configFile

Type: String Default value: none

The location of your .json file that describes which git repos you want to clone and where they should go.

options.overWrite

Type: Boolean Default value: false

The overWrite setting stops the plugin deleting folders that already exist. So if you run plugin and the folder is already there then it will not do anything. If overWrite is set to true if the folder exists then it be deleted before the clone takes place.

options.npmInstall

Type: Boolean Default value: false

This will call npm install on each repo that is cloned from git. Its first checks for a package.json to avoid issues.

options.bowerInstall

Type: Boolean Default value: false

This will call bower install on each repo that is cloned from git. Its first checks for a bower.json to avoid issues.

options.postClone

Type: String Default value: ``

If you need to run a command after you have cloned your repos, you should add it here. If you need to run multiple commands they should be separated by the && symbol. eg 'grunt build && grunt anotherTask' - beware of over using this option.

options.depth

Type: Number Default value: 0

Specifiy clone depth. 0 will recurse all the way down the tree.

options.noSingleBranch

Type: 'Boolean' Default value: false.

--no-single-branch git clone option.

Usage Examples

Default Options

Your options object should look something like this :

grunt.initConfig({
  batch_git_clone: {
    options: {
      configFile:"sample.json",
      npmInstall:true,
      bowerInstall:true,
      overWrite:true
    }
  },
});

Your JSON file should be in this format, you can use https or ssh links (but see the got'ya below) :

{
  "clones-folder": {
    "promises": {
      "q" : "https://github.com/kriskowal/q.git",
      "async" : "https://github.com/caolan/async.git"
    },
    "rust": {
      "rust_game" : "https://github.com/benbrunton/rusteroids.git"
    },
    "frameworks": {
      "front": {
        "angular" : "[email protected]:angular/angular.git"
      },
      "angular" : "[email protected]:angular/angular.git"
    }
  }
}

This will create the following paths, existing folders will be deleted if they are already there as overWrite is set to true.

/clones-folder/promises/q
/clones-folder/promises/async
/clones-folder/rust/rust_game
/clones-folder/frameworks/front/angular
/clones-folder/frameworks/angular

The relevant git repos will then be cloned in to those folders, and then both bower install and npm install will be run on those repos.

Gotya's

Bear in mind that if you choose to use this on server during deployment you should use the 'https' links to the git repos as the keys will not be available to use the 'git@' version.

Tests

To run the tests run grunt test.

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

(Nothing yet)