https://github.com/wpengine/site-deploy

Base image to build VCS integrations enabling customers to deploy their site to WP Engine
https://github.com/wpengine/site-deploy

rd

Last synced: about 2 months ago
JSON representation

Base image to build VCS integrations enabling customers to deploy their site to WP Engine

• Host: GitHub
• URL: https://github.com/wpengine/site-deploy
• Owner: wpengine
• License: mit
• Created: 2022-11-18T20:47:33.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T15:21:13.000Z (3 months ago)
• Last Synced: 2024-10-18T10:33:27.906Z (3 months ago)
• Topics: rd
• Language: Shell
• Size: 185 KB
• Stars: 4
• Watchers: 40
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
# wpengine/site-deploy

Base image to build VCS integrations enabling customers to deploy their site to WP Engine

## How to Build

You can build and version this image using make targets.

```sh

make build       # Builds the image locally

make version     # Builds the image and creates version tags

make list-images # Shows all tagged versions of the image

make clean       # Deletes all tagged versions of the image

```

## How to Run

You can use this image to deploy a site from your local machine.

1. Build the `wpengine/site-deploy:latest` image with `make build`.

2. Change directories into the root of the local site you'd like to deploy.

3. Create a `.env` file with the following variables, changing their values as needed.

> [!WARNING]  

> Since `docker run` does not strip double-quotes from variables in the .env file, we don't use them

> to wrap entire variable values. Instead, we must use single or double-quotes around flag values that

> contain whitespace to prevent splitting (`--filter=':= .gitignore'`). The `=` sign between the flag

> and its value is also required (`--filter=':= .gitignore'` rather than `--filter ':= .gitignore'`).

```sh

# Required. The target WP Engine install name.

WPE_ENV=yourinstall

# Optional. Default values shown.

REMOTE_PATH=

SRC_PATH=.

PHP_LINT=FALSE

CACHE_CLEAR=TRUE

SCRIPT=

FLAGS=-azvr --inplace --exclude='.*'

```

3. Set an environment variable with your private SSH key, replacing the key file name with your own.

```sh

export WPE_SSHG_KEY_PRIVATE=`cat ~/.ssh/my_sshg_key_rsa`

```

4. Run the deploy!

```sh

 docker run --rm \

    -e "WPE_SSHG_KEY_PRIVATE" \

    --env-file ./.env \

    -v $(pwd):/site \

    --workdir=/site \

    wpengine/site-deploy:latest

```