Minimalistic deployment shell script.
$ make install
Visit the wiki for additional usage information.
Usage: deploy [options] <env> [command] Options: -C, --chdir <path> change the working directory to <path> -c, --config <path> set config path. defaults to ./deploy.conf -T, --no-tests ignore test hook -V, --version output program version -h, --help output help information Commands: setup run remote setup commands update update deploy to the latest release revert [n] revert to [n]th last deployment or 1 config [key] output config file or [key] curr[ent] output current release commit prev[ious] output previous release commit exec|run <cmd> execute the given <cmd> console open an ssh session to the host list list previous deploy commits [ref] deploy to [ref], the 'ref' setting, or latest tag
deploy(1) will look for ./deploy.conf, consisting of one or more environments,
[production], etc, followed by directives.
[stage] key /path/to/some.pem user deployer host n.n.n.n repo firstname.lastname@example.org:visionmedia/express.git path /var/www/myapp.com ref origin/master post-deploy /var/www/myapp.com/update.sh
Path to identity file used by
When specified, HEAD is reset to
ref. When deploying
production typically this will not be used, as
utilize the most recent tag by default, however this is useful
for a staging environment, as shown below where HEAD is updated
and set to the develop branch.
User for deployment.
GIT repository to clone.
Webhosts normally use read-only deploy keys to access private git repositories.
If you'd rather use the credentials of the person invoking the deploy
forward-agent yes in the relevant config sections.
Now the deploy script will invoke
ssh -A when deploying and there's
no need to keep SSH keys on your servers.
If your deployment scripts require any user interaction (which they shouldn't, but
often do) you'll probably want SSH to allocate a tty for you. Put
in the config section if you'd like the deploy script to invoke
ssh -t and ensure
you have a tty available.
All hooks are arbitrary commands, executed relative to
aka the previous deployment for
pre-deploy, and the new deployment
post-deploy. Of course you may specify absolute paths as well.
Post-deployment test command after
post-deploy. If this
deploy(1) will attempt to revert to the previous
deployment, ignoring tests (for now), as they are assumed to have run correctly.
(The MIT License)
Copyright (c) 2011 TJ Holowaychuk <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.