diff --git a/.changeset/swift-maps-grab.md b/.changeset/swift-maps-grab.md deleted file mode 100644 index aa95556..0000000 --- a/.changeset/swift-maps-grab.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -"@wpengine/site-deploy": major ---- - -Updates the main script to be more generic, allowing it to be used around different CI/CD Vendors. - -In order to use this image, each CI/CD vendor implementation will need to set the environment variables accordingly: - -```sh -WPE_ENV # The target WP Engine install name -REMOTE_PATH # Default is empty -SRC_PATH # Default is the current directory -FLAGS # Default is -azvr --inplace --exclude=".*" -PHP_LINT # Default is "FALSE" -CACHE_CLEAR # Default is "TRUE" -SCRIPT # Default is empty -``` - -Example of how to run this image: - -```sh - docker run --rm \ - -e "WPE_SSHG_KEY_PRIVATE" \ - --env-file ./.env \ - -v :/site \ - --workdir=/site \ - wpengine/site-deploy:latest -``` diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..666e914 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,30 @@ +# @wpengine/site-deploy + +## 1.0.0 + +### Major Changes + +- 58eb612: Updates the main script to be more generic, allowing it to be used around different CI/CD Vendors. + + In order to use this image, each CI/CD vendor implementation will need to set the environment variables accordingly: + + ```sh + WPE_ENV # The target WP Engine install name + REMOTE_PATH # Default is empty + SRC_PATH # Default is the current directory + FLAGS # Default is -azvr --inplace --exclude=".*" + PHP_LINT # Default is "FALSE" + CACHE_CLEAR # Default is "TRUE" + SCRIPT # Default is empty + ``` + + Example of how to run this image: + + ```sh + docker run --rm \ + -e "WPE_SSHG_KEY_PRIVATE" \ + --env-file ./.env \ + -v :/site \ + --workdir=/site \ + wpengine/site-deploy:latest + ``` diff --git a/package.json b/package.json index 1082d12..b485943 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@wpengine/site-deploy", - "version": "0.1.0", + "version": "1.0.0", "private": true, "engines": { "node": ">=16",