wp-deploy-flow

A wp-cli command to deploy your wordpress instance.

Dependencies

• Wordpress
• wp-cli : http://wp-cli.org
• rsync

Install - Usage

Check here : http://demental.info/blog/2013/04/09/a-decent-wordpress-deploy-workflow/

Setting up environments

You can create as many environments as you want, all the environments must be setup in your wp-config.php file, with prefixed constants.

For example if you want to create a staging environment, create all the necessary constants to configure it such as : STAGING_DB_HOST, STAGING_DB_USER, STAGING_URL and so on .... And copy all those configuration constats to all the other environments you want to interact with.

Available constants:

[ENV]_DB_HOST / USER / NAME / PORT / PASSWORD

• Database dsn for the environment
• Mandatory: Yes except for port (default 3306)

[ENV]_SSH_DB_HOST / USER / PATH / PORT

• If you need to connect to the destination database through SSH
• Mandatory: No, port defaults to 22

[ENV]_SSH_HOST / USER / PORT

• SSH host to sync with Rsync
• Mandatory: No, port defaults to 22

[ENV]_PATH

• Server path for the environment (used to reconfigure the Wordpress database)
• Mandatory: Yes

[ENV]_URL

• Url of the Wordpress install for this environment (used to reconfigure the Wordpress database)
• Mandatory: Yes

[ENV]_EXCLUDES

• Add files to exclude from rsync (a good idea is - temporarily I hope - to remove .htaccess to avoid manual flush rewrite). List must be separated buy semicolons.
• Mandatory: No

Local deployment

wp-deploy-flow command is a nice tool to have a draft copy of your website, play with your draft, do whatever mistake and roll back from production to staging, or for preparing a big update and deploy in a snap. Although it's best to have separate servers for each environments, you still can have your draft environment on the same HTTP server, in a subfolder or a subdomain. For same-server environments, the configuration is much simpler : you just need to fill the PATH, URL, DB_HOST / USER / NAME / PASSWORD for each environment, SSH will not be used in this case. If one environemnt is in a subfolder of the other, it will be automatically excluded from rsync copy to avoid infinite recursion.

Usage

wp-deploy-flow comes includes:

• four subcommands : pull, pull_files, push and push_files
• one flag : --dry-run as you can guess this flag allows you to see what SSH commands will be executed before actually launching them.

All subcommands have the same signature :

wp deploy <subcommand> <environment> [--dry-run]

Testing

Shame on me... No automated tests, this is manually tested, but I recently redesigned the code so it should be easier now to cover the project (at least the core classes : puller and pusher).

If you want to contribute, be kind, send a PR I will be happy to review and merge !