grunt-ssh-deploy-release

grunt-ssh-deploy-release

Create an archive of "localPath" (except excluded folders). Copy this archive to remote server using SCP. Decompress the release on remote server. Create "shared" folders symlink. Create release symlink. Clean temporary files and old releases.

Installation

npm install grunt-ssh-deploy-release

Grunt configuration

grunt.config.set('ssh-deploy-release', {

	// Global options
	// ==============
    options: {

    	// Local folder to deploy
        localPath: 'www',

        // Excluded local folders
        exclude: [
            'tmp/**',
            'images/**',
        ],

        // Shared folders (use symlink)
        // Example : 'sharedFolder' : 'linkName'
        share: {
            'images': 'assets/images',
        }
    },


    // Environments
    // ============

    // Preproduction
    preproduction: {
        options: {
            host: 'hostname',
            username: 'username',
            password: 'password',
            deployPath: '/opt/path/to'
        }
    },

    // Production
    production: {
        options: {
            host: 'hostname',
            username: 'username',
            password: 'password',
            deployPath: '/opt/path/to'
        }
    }
});

Usage

Deploy to "environmentName"

grunt ssh-deploy-release:environmentName

Options

SCP connection

port

Port used to connect to remote server. Default : 22

host

Remote server hostname.

username

Username used to connect to remote server.

password

Password used to connect to remote server.

deployPath

Absolute path on remote server where release will be deployed.

readyTimeout

SCP connection timeout duration. Default : 20000

Path

currentReleaseLink

Name of the current release symbolic link. Relative to deployPath. Defaut : 'www'

sharedFolder

Name of the folder containing shared folders. Relative to deployPath. Default : 'shared'

releasesFolder

Name of the folder containing releases. Relative to deployPath. default : 'releases'

localPath

Name of the local folder to deploy. Default : 'www'

Releases

archiveName

Name of the archive. Default : 'release.zip'

releasesToKeep

Number of releases to keep on remote server. Default : 3

tag

Name of the release. Must be different for each release. Default : Use current timestamp.

exclude

List of paths (glob format) to not deploy. Paths must be relative to localPath. Default : []

share

List of folders to "share" between release. A symlink will be created for each item.

Keys = Folder to share (relative to sharedFolder)

Values = Symlink path (relative to release folder)