Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 3.77 KB

README.md

File metadata and controls

99 lines (61 loc) · 3.77 KB
Raw

CircleCI Orb for WP Engine Deploys

This is an orb that can be used in your CircleCI workflows. You can use it to test WordPress site repos and deploy to WP Engine environments.

Available Options

Jobs

wpengine/build

Build the files. Runs composer install, yarn install, and yarn build if a build job is defined. This is the base job that creates the core files used by all other jobs. It's a required step 1.

wpengine/lint

Lint the files to make sure everything follows best practices. Runs both composer lint and yarn lint if they're defined.

wpengine/codeception

Run codeception tests for end-to-end testing. Codeception supports unit, wpunit functional, and acceptance testing. Please note that the job needs two parameters defined for plugins and themes

Parameter Description
package_type One of plugin, theme, or project
package_name The directory name of the plugin or theme. Where should it be installed.

wpengine/backstop

Run visual regression tests using backstopjs. Takes a single required parameter

Parameter Description
config Path to the backstopjs config file

wpengine/deploy_site

Deploys a site to a WP Engine install. The deploy process removes dev dependencies and any internal git settings.

Parameter Description
environment One of production, staging, development, or SpecificInstallName

wpengine/deploy_fury

Deploys a plugin or theme to Gemfury. The deploy process compiles static files, removes dev dependencies and recreates the tag.

Parameter Description
user Environment variable that defines the Gemfury user. Defaults to GEMFURY_USER.
token Environment variable that defines the Gemfury push token. Defaults to GEMFURY_TOKEN_PUSH.
project Project name that Gemfury should deploy to. Defaults to the repository name.

wpengine/deploy_pr

IN PROGRESS Draft job that creates a new pull request for the next step of the deploy process when a branch is merged into development or staging.

Parameter Description
target Branch for the PR to target.

wpengine/backup

Custom backup job for our sites that have the @dxt/backup package installed.

Executors

wpengine/php

A basic PHP 7.4 container with node included.

Commands

wpengine/gitignoreswap

Swaps the .gitignore file for a plugin, theme, or project to a production-friendly gitignore that excludes source and test files.

Parameter Description
gitignore_type One of site or package.

Sample CircleCI Config

See the sample circleci config files for a copy-paste solution to get you up and running.

Environment Variables

I suggest you define your environment variables in your Project Settings. See CircleCI documentation on the many ways to define environment variables.

  • WPE Environment variables are required for deployments. These should match your WP Engine site environment names.
  • A Rollbar access token allows you to notify rollbar about the deploy process
  • A Composer Auth variable allows you to install private GitHub repositories with your personal GitHub token.
WPE_PRODUCTION_ENVIRONMENT=mysite
WPE_STAGING_ENVIRONMENT=mysitestaging
WPE_DEVELOPMENT_ENVIRONMENT=mysitedevelop
ROLLBAR_ACCESS_TOKEN=abcdef123456
COMPOSER_AUTH={"github-oauth":{"github.com":"abcdef123456"}}