deploy is a shell script designed to speed up and automate project deployment. Its main focus is Wordpress websites, but it can be used with any code repository. This script is in daily use at EMRL, an advertising, design, and development agency in northern California. If you have any questions, please feel free to contact us.
Please note that our documentation here is nearly useless, and there is quite a bit of setup involved in getting this running reliably. A full setup guide is coming soon™.
Usage: deploy [options] [target] ...
Options:
-F, --force Skip all user interaction, forces 'Yes' to all actions
-S, --skip-update Skip any Wordpress core/plugin updates
-u, --update If no available Wordpress updates, halt deployment
-P, --publish Publish current production code to live environment
-m, --merge Force merge of branches
-c, --current Deploy a project from current working directory
-t, --time Add time to project management integration
-V, --verbose Output more process information to screen
-q, --quiet Display minimal output on screen
-h, --help Display this help and exit
-v, --version Output version information and exit
Other Options:
--automate For unattended deployment via cron
--approve Approve and deploy queued code changes
--deny Deny queued code changes
--digest Create and send weekly digest
--no-check Override active file and server checks
--stats Generate project statistics pages
--strict Any error will halt deployment completely
--debug Run in debug mode
--unlock Delete expired lock files
--ssh-test Validate SSH key setup
--email-test Test email configuration
--slack-test Test Slack integration
--analytics-test Test Google Analytics authentication
--function-list Output a list of all functions()
--variable-list Output a project's declared variables
Basically, this thing is a wrapper that simplifies web app deployment from a development or staging environment to a production server. At the moment is mostly focused on Wordpress projects but in it should work for other stuff too.
This script requires git, and will make use of wp-cli, grunt, npm, and mina if they are installed.
deploy can be run from wherever you've installed it, but if you'd like it to be installed server-wide, follow the instructions below.
- In the
deploydirectory, typesudo ./install/doinst.shand enter your sudo password when/if asked - That's it. By default
deployis installed to/usr/local/bin/and support files are installed to/etc/deploy/
Configuration is handled in the etc/deploy.conf file. Individual users can also keep their own settings in ~/.deployrc
Repositories can each have their own deploy configuration. An example of this file can be found here.
For workgroups and teams that use it, deploy is able to integrate with Slack. You'll need to set up an "Incoming Webhook" custom integration on the Slack side to get this ready to roll. See https://YOURTEAMNAME.slack.com/apps/manage/custom-integrations to get going. Once you think you've got Slack configured, run deploy --slack-test [project] to test.
deploy --automate works well for unattended updates of Wordpress sites; great for maintaining updates via a crontab. An example cron script can be found here. Running in this mode, the project will only be deployed if there are Wordpress core or plugin updates. If other code changes are detected the project will not be auto-updated. Smart Commits must be enabled or nothing will be deployed.