This GitHub Action may be used to deploy code from a Github repo to a WP Engine environment of your choosing. Deploy a full site directory, or optionally just a theme, plugin or other directory with the TPO options. Other options include performing a PHP Lint, custom rsync flags, or clearing cache.

V2.3.3 NOW AVAILABLE! View Changelog here.

1. Copy the following main.yml to .github/workflows/main.yml in your root of your local WordPress project/repo, replacing values of PRD_BRANCH, PRD_ENV for the branch and WPE Environment name of your choice. Optional vars can be specified as well. Consult "Environment Variable & Secrets" for more available options.

2. Generate a new SSH key pair if you have not already done so. Add the SSH Private Key to your Github repo settings.

   Repo > Settings > Secrets > Actions Secrets > New Repository Secrets

   Save the new secret "Name" as WPE_SSHG_KEY_PRIVATE. More reading available here for Repo Secrets

3. Add SSH Public Key to WP Engine SSH Gateway Key settings. This Guide will show you how.

   NOTE: This Action DOES NOT utilize WP Engine GitPush or the GitPush SSH keys found here.

4. Git push your site Github repo. The action will do the rest!

View your actions progress and logs by navigating to the "Actions" tab in your repo.

name: Deploy to WP Engine
on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest  
    steps: 
    - uses: actions/checkout@v2
    - name: GitHub Action Deploy to WP Engine
      uses: wpengine/[email protected]
      with:
      
      # Deploy vars
        WPE_SSHG_KEY_PRIVATE: ${{ secrets.WPE_SSHG_KEY_PRIVATE }} 
      
      # Branches & Environments 
        PRD_BRANCH: main
        PRD_ENV: prodsitehere

name: Deploy to WP Engine
on:
  push:

jobs:
  build:
    runs-on: ubuntu-latest  
    steps: 
    - uses: actions/checkout@v2
    - name: GitHub Action Deploy to WP Engine
      uses: wpengine/[email protected]
      with:
      
      # Deploy vars 
        WPE_SSHG_KEY_PRIVATE: ${{ secrets.WPE_SSHG_KEY_PRIVATE }} 
        PHP_LINT: TRUE
        FLAGS: -azvr --inplace --delete --exclude=".*" --exclude-from=.deployignore
        CACHE_CLEAR: TRUE
        TPO_SRC_PATH: "wp-content/themes/genesis-child-theme/"
        TPO_PATH: "wp-content/themes/genesis-child-theme/"
      
      # Branches & Environments 
        PRD_BRANCH: main
        PRD_ENV: prodsitehere
        
        STG_BRANCH: feature/stage
        STG_ENV: stagesitehere
        
        DEV_BRANCH: feature/dev
        DEV_ENV: devsitehere

• Defining environment variables in GitHub Actions
• Storing secrets in GitHub repositories
• As this script does not restrict files or directories that can be deployed, it is recommended to leverage one of WP Engine's .gitignore templates.