Deploy a Bedrock+Sage WordPress project to the WP Engine hosting platform

Update: v2 removes build process for Sage theme. Now focuses purely on deploying your Bedrock project, regardless of theme. Since each project will have a different build process for its theme, it makes more sense to focus solely on deploying to WP Engine. More info in this issue.

Brief

This bash script prepares a WordPress project built on Roots’ Bedrock boilerplate with the Sage starter theme and deploys it to the WP Engine hosting platform. It can be easily modified if you do not use the Sage theme.

Purpose

WP Engine expects to see a standard WordPress project in the document root for your account. Since Bedrock shifts folders and files around a bit, this script temporarily moves everything back to their original locations (on a safe, temporary branch), which is then pushed to WP Engine.

The result is a properly-versioned Bedrock repo that you can safely and repeatedly deploy to WP Engine’s production and staging environments.

Installation & Setup

1. Grab the script

Source code is available at https://github.com/hello-jason/bedrock-sage-deploy-to-wpengine. This repo is not meant to be cloned into your project. Rather, just grab the wpedeploy.sh file and place it in the top-level directory of your Bedrock project, and keep it with your project’s repo.

2. Setup git push

Follow these instructions from WP Engine to setup SSH access and git push for your WP Engine account.

This guide assumes your remotes are named as follows:

3. Set theme variable

Out the box, this script assumes your theme’s name is sage. Open wpdeploy.sh and change the following variable (around line 17).

4. Run script

In short, it performs a few checks, creates a temporary deployment branch, then builds the site locally. It force pushes to the specified environment using WP Engine’s git push feature. When complete, it removes the temp branch and puts you back on the branch you started from.

Run at the top level of your project, in the same directory as your .env and composer.json files. Replace each remote name with the ones you created during step 1. Note, running this script with the bash command is important; Ubuntu defaults to dash rather than bash, and the script will fail if you simply run sh.

Deploy to staging:

1
bash wpedeploy.sh wpestaging

Deploy to production:

1
bash wpedeploy.sh wpeproduction

FAQs


↩ All articles
comments powered by Disqus