feat(scripts): update README to include confirming AWS profile #15382
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jerader
commented
Jun 11, 2024
scripts/deploy/README.md
Outdated
Comment on lines
18
to
19
| Additionally, the Promote Sandbox to Staging and Staging to Production scripts will prompt you to confirm that you are using the correct AWS profile. Press either `y` to confirm and proceed or `n` to cancel. | ||
|
|
There was a problem hiding this comment.
@ecormany can you proofread this when you get the chance?
There was a problem hiding this comment.
Suggested change
| Additionally, the Promote Sandbox to Staging and Staging to Production scripts will prompt you to confirm that you are using the correct AWS profile. Press either `y` to confirm and proceed or `n` to cancel. | |
| Additionally, the `promote-to-staging` and `promote-to-production` scripts will confirm that you are using the correct AWS profile. At the prompt, enter either `y` to confirm and proceed or `n` to cancel. | |
sth like this. "press" -> "enter" because you have to submit it (just the Y or N keystroke doesn't perform the action).
There was a problem hiding this comment.
ooh yes, this is much clearer. thank you!!
ecormany
approved these changes
Jun 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes AUTH-505
Overview
Figured we should keep the README up to date to include info about how the promote to staging and promote to production scripts now prompt you to confirm if you are using the correct AWS profile.
Test Plan
proofread my copy. does it make sense?
Changelog
just add a blurb in the readme
Review requests
see test plan
Risk assessment
low