Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add note about test mode for deployment commands #38

Open
wants to merge 1 commit into
base: spr/alpha/147812e6
Choose a base branch
from
Open

docs: add note about test mode for deployment commands #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading