Skip to content

Commit 6f4e339

Browse files
committed
update README for FLAGS
1 parent b70683b commit 6f4e339

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub Action for WP Engine Site Deployments
22

3-
This GitHub Action can be used to deploy code from Github repo to a WP Engine environment of your choosing. Deploy a a full site directory, or optionally a theme, plugin or other directory with the TPO options. Optionally lint your php pre-deployment. Post deploy, this action will automatically purge your WP Engine cache to ensure all changes are visible.
3+
This GitHub Action can be used to deploy code from Github repo to a WP Engine environment of your choosing. Deploy a full site directory, or optionally a theme, plugin or other directory with the TPO options. Optionally lint your php pre-deployment. Post deploy, this action will automatically purge your WP Engine cache to ensure all changes are visible.
44

55
V2.0 NOW AVAILABLE!
66
Note: v2.0 enhancements WILL break previous version yaml configs. To utilize the new features, users must update main.yml to match format below. If issues persist post update, please contact WP Engine Support.
@@ -30,7 +30,7 @@ jobs:
3030
# Keys, lint & url options
3131
WPE_SSHG_KEY_PRIVATE: ${{ secrets.WPE_SSHG_KEY_PRIVATE }}
3232
PHP_LINT: TRUE
33-
FLAGS: -a --inplace --out-format="%n" --exclude=".*"
33+
FLAGS: -azvr --inplace --exclude=".*"
3434
TPO_SRC_PATH: ""
3535
TPO_PATH: ""
3636
@@ -64,6 +64,7 @@ jobs:
6464
| `DEV_BRANCH` | string | Insert the name of a development Github branch you would like to deploy from. Note: exclude leading / in branch names.|
6565
| `DEV_ENV` | string | Insert the name of the WP Engine Dev environment you want to deploy to. |
6666
| `PHP_LINT` | bool | Set to TRUE to execute a php lint on your branch pre-deployment. Set to FALSE to bypass lint. |
67+
| `FLAGS` | string | Set optional rsync flags such as `--delete`. This action defaults to a non-destructive deploy using the flags in the example above. |
6768
| `TPO_SRC_PATH` | string | Optional path to specify a theme, plugin, or other directory source to deploy from. Ex. `"wp-content/themes/genesis-child/"` . Defaults to "." Dir. |
6869
| `TPO_PATH` | string | Optional path to specify a theme, plugin, or other directory destination to deploy to. Ex. `"wp-content/themes/genesis-child/"` . Defaults to WordPress root directory. |
6970

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ inputs:
1010
FLAGS:
1111
description: "optional flags for the deployment"
1212
required: false
13-
default: '-azvr --exclude=".*"'
13+
default: '-azvr --inplace --exclude=".*"'
1414
TPO_SRC_PATH:
1515
description: "An optional source directory to deploy other than the root directory that is being versioned."
1616
default: ""

0 commit comments

Comments
 (0)