source: Dev/trunk/node_modules/grunt-git-deploy/package.json @ 529

{
  "name": "grunt-git-deploy",
  "description": "Deploy files to any branch of any remote git repository.",
  "version": "0.1.1",
  "homepage": "https://github.com/iclanzan/grunt-git-deploy",
  "author": {
    "name": "Sorin Iclanzan",
    "email": "sorin@iclanzan.com",
    "url": "http://songpane.com/"
  },
  "repository": {
    "type": "git",
    "url": "git://github.com/iclanzan/grunt-git-deploy.git"
  },
  "bugs": {
    "url": "https://github.com/iclanzan/grunt-git-deploy/issues"
  },
  "licenses": [
    {
      "type": "MIT",
      "url": "https://github.com/iclanzan/grunt-git-deploy/blob/master/LICENSE-MIT"
    }
  ],
  "main": "Gruntfile.js",
  "engines": {
    "node": ">= 0.8.0"
  },
  "scripts": {
    "test": "grunt test"
  },
  "devDependencies": {
    "grunt-contrib-clean": "~0.4.0",
    "grunt-contrib-copy": "~0.4.1",
    "grunt-contrib-nodeunit": "~0.1.2",
    "grunt": "~0.4.1"
  },
  "peerDependencies": {
    "grunt": "~0.4.1"
  },
  "keywords": [
    "gruntplugin",
    "git",
    "deploy",
    "push"
  ],
  "readme": "# grunt-git-deploy\n\n> Deploy files to any branch of any remote git repository.\n\n## Getting Started\nThis plugin requires Grunt `~0.4.1`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-git-deploy --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-git-deploy');\n```\n\n## The \"git_deploy\" task\n\n### Overview\nThe way this task works is it creates an empty git repository in the `src` directory you specify, creates an orphan branch and commits all files from that directory to it. Then it pushes the branch to the configured remote repository. **Be careful as this destroys the history of the remote branch.**\n\nIn your project's Gruntfile, add a section named `git_deploy` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n  git_deploy: {\n    your_target: {\n      options: {\n        url: 'git@github.com:example/repo.git'\n      },\n      src: 'directory/to/deploy'\n    },\n  },\n})\n```\n\n### Options\n\n#### options.url\nType: `String`\n\nThe URL to a remote git repository. This option is required.\n\n#### options.branch\nType: `String`\nDefault value: `'gh-pages'`\n\nThe branch to push to.\n\n#### options.message\nType: `String`\nDefault value: `'autocommit'`\n\nCommit message.\n\n## Contributing\nIf you can think of a way to unit test this plugin please take a shot at it.\n",
  "readmeFilename": "README.md",
  "_id": "grunt-git-deploy@0.1.1",
  "dist": {
    "shasum": "805634de159e88cec8e34ffc4f8b8ebc1246f654"
  },
  "_from": "grunt-git-deploy@",
  "_resolved": "https://registry.npmjs.org/grunt-git-deploy/-/grunt-git-deploy-0.1.1.tgz"
}