Help deploying apps on Gandi Simple Hosting using Git.
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-gandi-deploy --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-gandi-deploy');
In your project's Gruntfile, add a section named gandi_deploy
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
gandi_deploy: {
your_target: {
options: {
login: 'your_gandi_login',
ssh_key_path: '/path/to/rsa/private/key',
},
src: 'path/to/deploy/directory'
},
},
});
Type: String
Your Simple Hosting instance admin login
Type: String
Path to your SSH private key. This method is strongly recommended.
Type: String
Password for your instance. This option is not recommended. Use SSH Key instead.
Type: String
Default value: 'default'
Vhost to deploy to. (Only `'default' on Node.js, Python or Ruby instances)
Type: String`` Default value:
'dc0'`
Your SimpleHosting instance datacenter location
Type: String
Default value: 'master'
Branch to deploy to.
Type: String
Default value: 'autocommit'
Commit message
Type: String
Default value: false
Tag for the release. The release is not tagged if value is false
Type: String
Default value: 'autocommit'
Message for the tag. Ignored if options.tag is false
Type: String
Default value: false
Whether to execute à git clean
operation on the vhost directory see Gandi Documentation for details
Type: String
Default value: 'origin'
Git remote name.
Type: String
Default value: 'tmp'
Plugin's working directory name. 'tmp'
is the default value but can be changed if needed.
There are no unit tests for this plugin yet. Use it carefully.
For more informations about Simple Hosting Git access, see Gandi Documentation
This plugin is not written or supported by Gandi.
This plugin has been inspired by grunt-git-deploy and uses some of its code.
Every contribution is welcome !