From 6d7d96c6f6dfb2574ff72c85fd55d09ec7ac803d Mon Sep 17 00:00:00 2001 From: Calvin Combs <66279577+comcalvi@users.noreply.github.com> Date: Tue, 8 Mar 2022 17:58:37 -0800 Subject: [PATCH] doc: added allowlist docs to CONTRIBUTING.md (#4048) --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 331ac6fe3c..099da6c304 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,6 +96,18 @@ specific service, for example: AWS_REGION=[set region] node node_modules/cucumber/bin/cucumber.js --tag @s3 ``` +Hardcoded region strings are not allowed in the SDK. To check the code for +the presence of hardcoded region strings, run + +``` +node ./scripts/region-checker/index.js +``` + +from the project root directory. If this command shows any output, the PR will +not be merged. Any lines that appear here must have the region string removed +or be added to `scripts/region-checker/allowlist.js`. Lines should only be +allowlisted if absolutely necessary. + ### Testing the documentation changes: To test the documentation changes, please ensure you have the following requirements installed (Please make sure you have the latest version of Ruby):