Makes it easy and fast to deploy your project
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-compress-deploy --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-compress-deploy');
In your project's Gruntfile, add a section named compress-deploy
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
compress-deploy: {
your_target: {
src : "/path/to/build",
dest : "/path/on/server",
server_sep : "/",
clean : true,
createDir : true,
touch : false,
exclusions : ['important', 'dont.touch'],
auth: {
host : 'yourdomain.com',
port : 22,
authKey : 'yourdomain.com'
}.
},
},
})
Type: String
Directory, which will be transfered to the server.
Type: String
Path to place on your server where the project should be put.
Type: Boolean
Default value: false
Set to true to create the dest directory when extracting the new version. Note: if the dest directory does not exist an error will be returned and deploy aborted.
Type: String
Default value: path.sep
What path separator your server uses?
Type: Boolean
Default value: false
Determines whether to clean location on server before putting there the new version.
Type: Boolean
Default value: false
Set to true to prevent extraction of file modified time.
Type: Array<String>
Default value: []
What elements must be preserved from the cleaning. Won't work if in src
directory are files of the same names.
Type: Boolean
Default value: false
If set to true
targz is initialized with proprietary headers.
Such behaviour causes errors if archive is created on a Mac OS X machine and
deployed to a Linux server. See issue #3 for more information.
Type: String
Default value: tmp.tar.gz
Name of the created and transferred archive.
Usernames, passwords, and private key references are stored as a JSON object in a file named .ftppass
. This file should be omitted from source control. It uses the following format:
{
"key1": {
"username": "username1",
"password": "password1"
},
"key2": {
"username": "username2",
"password": "password2"
},
"privateKey": {
"username": "username"
},
"privateKeyEncrypted": {
"username": "username",
"passphrase": "passphrase1"
},
"privateKeyCustom": {
"username": "username",
"passphrase": "passphrase1",
"keyLocation": "/full/path/to/key"
}
}
If keyLocation
is not specified, grunt-compress-deploy
looks for keys at ~/.ssh/id_dsa
and /.ssh/id_rsa
.
You can supply passwords for encrypted keys with the passphrase
attribute.
This way we can save as many username / password combinations as we want and look them up by the authKey
value defined in the grunt config file where the rest of the target parameters are defined.
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.
(Nothing yet)