Deploy files to any branch of any remote git repository.
This plugin requires Grunt ~0.4.1
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-deploy --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-git-deploy');
The 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.
In your project's Gruntfile, add a section named git_deploy
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
git_deploy: {
your_target: {
options: {
url: 'git@github.com:example/repo.git'
},
src: 'directory/to/deploy'
},
},
})
Type: String
The URL to a remote git repository. This option is required.
Type: String
Default value: 'gh-pages'
The branch to push to.
Type: String
Default value: 'autocommit'
Commit message.
Type: Boolean
Default value: true
Suppress git console output, including output from remote server when pushing.
If you can think of a way to unit test this plugin please take a shot at it.