Set of deployment tasks for Shipit based on rsync.
Features:
- Deploy folder to a remote
- Add additional behaviour using hooks
- Build your project locally or remotely
- Easy rollback
TODO
npm install shipit-deploy
If you are deploying from Windows, you may want to have a look at the wiki page about usage in Windows.
module.exports = function (shipit) {
require('shipit-deploy')(shipit);
shipit.initConfig({
default: {
workspace: '/tmp/github-monitor',
deployTo: '/tmp/deploy_to',
keepReleases: 2,
deleteOnRollback: false,
shallowClone: true,
revision: '2.0'
},
staging: {
servers: 'user@myserver.com'
}
});
};
To deploy on staging, you must use the following command :
shipit staging deploy
You can rollback to the previous releases with the command :
shipit staging rollback
Type: String
Define a path to an empty directory where Shipit builds it's syncing source. Beware to not set this path to the root of your repository as shipit-deploy cleans the directory at the given path as a first step.
Type: String
Revision number that will be written to a REVISION file in each release.
Type: String
Default: same as workspace
Define directory within the workspace which should be deployed.
Type: String
Define the remote path where the project will be deployed. A directory releases
is automatically created. A symlink current
is linked to the current release.
Type: Boolean
Whether or not to delete the old release when rolling back to a previous release.
Type: Number
Number of releases to keep on the remote server.
Type: Boolean
Perform a shallow clone. Default: false
.
Type: String
Optional
When deploying from Windows, prepend the workspace path with the drive letter. For example /d/tmp/workspace
if your workspace is located in d:\tmp\workspace
.
By default, it will run rsync from the workspace folder.
Type: String
Parameter to pass to cp
to copy the previous release. Non NTFS filesystems support -r
. Default: -a
Several variables are attached during the deploy and the rollback process:
All options described in the config sections are available in the shipit.config
object.
Attached during deploy:update
and rollback:init
task.
The current release dirname of the project, the format used is "YYYYMMDDHHmmss" (moment format).
Attached during deploy:init
, rollback:init
, and pending:log
tasks.
The remote releases path.
Attached during deploy:update
and rollback:init
task.
The complete release path : path.join(shipit.releasesPath, shipit.releaseDirname)
.
Attached during deploy:init
, rollback:init
, and pending:log
tasks.
The current symlink path : path.join(shipit.config.deployTo, 'current')
.
- deploy
- deploy:init
- Emit event "deploy".
- deploy:update
- Create and define release path.
- Remote copy project.
- Emit event "updated".
- deploy:publish
- Update symlink.
- Emit event "published".
- deploy:clean
- Remove old releases.
- Emit event "cleaned".
- deploy:finish
- Emit event "deployed".
- deploy:init
- rollback
- rollback:init
- Define release path.
- Emit event "rollback".
- deploy:publish
- Update symlink.
- Emit event "published".
- deploy:clean
- Remove old releases.
- Emit event "cleaned".
- rollback:finish
- Emit event "rollbacked".
- rollback:init
- pending
- pending:log
- Log current revision to console
- pending:log
- rsync 3+
- OpenSSH 5+
- GNU coreutils 5+
MIT