From 7bf3ef421f02983b107a5c56f6422f4757bb3ce5 Mon Sep 17 00:00:00 2001 From: Levi Bostian Date: Thu, 21 Nov 2024 07:09:45 -0600 Subject: [PATCH] docs: add note about test mode for deployment commands commit-id:eab50a70 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index afae9bc..60d27bc 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,13 @@ input_data = json.loads(input_data_json_string) # Your script can now get whatever data is useful, such as the new version name. next_version_name = input_data.get("nextVersionName") -# For a full list of all JSON keys available to you, see: https://github.com/levibostian/new-deployment-tool/blob/main/lib/steps/types/deploy.ts#L3-L10 +# IMPORTANT: Test mode +# When running this tool in a pull request, the tool will run in "test mode". +# When in test mode, run your deployment script as usual, but do not push code to your production server to actually deploy code. +# Feel free to push to a test server or just print out what you would do. +is_in_test_mode = input_data.get("testMode") + +# For a full list of all JSON keys available to you, see: https://github.com/levibostian/new-deployment-tool/blob/HEAD/lib/types/environment.ts ``` #### 2. Perform the deployment