Drop support for non-standard, deprecated AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables
#1054
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
…ECRET_KEY` environment variables Up until #855, we used non-standard environment variables for configuring AWS S3 credentials. With #855, we *added* support for the standard `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` variables, but maintained support for the old names, printing a warning when they're used. We've had that behaviour for 4 months now, and it's time to cut the old behaviour. With this change, only the new environment variable names will be accepted, and trying to use the old names will result in your argument not being recognised. Closes #856.
timrogers
force-pushed
the
timrogers/deprecate-non-standard-aws-environment-variables
branch
from
e1b136f
to
56d353c
Compare
timrogers
commented
Jul 5, 2023
| @@ -16,40 +17,20 @@ public AwsApiFactoryTests() | |||
| } | |||
|
|
|||
| [Fact] | |||
| public void It_Falls_Back_To_Aws_Access_Key_Environment_Variable_If_Aws_Access_Key_Id_Is_Not_Set() | |||
| public void It_Errors_If_Aws_Access_Key_Id_Is_Not_Provided_Or_Set_In_Environment_Variable() | |||
There was a problem hiding this comment.
We probably could remove this test file entirely as we don't test other similar logic - but writing this test gave me confidence that my changes were doing the right thing.
timrogers
commented
Jul 5, 2023
| @@ -740,42 +738,6 @@ public async Task It_Throws_When_Aws_Bucket_Name_Is_Provided_But_But_No_Aws_Acce | |||
| .WithMessage("*--aws-access-key*AWS_ACCESS_KEY_ID*"); | |||
| } | |||
|
|
|||
| [Fact] | |||
| public async Task It_Does_Not_Throw_When_Aws_Bucket_Name_Is_Provided_And_Can_Fallback_To_Aws_Access_Key_Environment_Variable() | |||
There was a problem hiding this comment.
This fallback behaviour is no longer here, so it doesn't need a test
timrogers
commented
Jul 5, 2023
| @@ -1231,94 +1229,6 @@ public async Task Ghes_When_Aws_Bucket_Name_Is_Provided_But_No_Aws_Access_Key_Id | |||
| .WithMessage("*--aws-access-key*"); | |||
| } | |||
|
|
|||
| [Fact] | |||
| public async Task Ghes_When_Aws_Bucket_Name_Is_Provided_And_Can_Fallback_To_Aws_Access_Key_Environment_Variable_Does_Not_Throw() | |||
There was a problem hiding this comment.
This fallback behaviour is no longer here, so it doesn't need a test
|
I just tested this locally, and I'm satisfied that it does what we're expecting 🏁 |
|
@timrogers Thank you for the graceful breaking change process here! I really appreciate that you took my feedback seriously. This saves us from angry and confused customers!!! |
dylan-smith
reviewed
Jul 5, 2023
dylan-smith
reviewed
Jul 5, 2023
dylan-smith
reviewed
Jul 5, 2023
Co-authored-by: Dylan Smith <dylanfromwinnipeg@gmail.com>
Co-authored-by: Dylan Smith <dylanfromwinnipeg@gmail.com>
Co-authored-by: Dylan Smith <dylanfromwinnipeg@gmail.com>
|
brianaj
approved these changes
Jul 6, 2023
timrogers
deleted the
timrogers/deprecate-non-standard-aws-environment-variables
branch
6 tasks
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.
Up until #855, we used non-standard environment variables for configuring AWS S3 credentials. With #855, we added support for the standard
AWS_ACCESS_KEY_IDandAWS_SECRET_ACCESS_KEYvariables, but maintained support for the old names, printing a warning when they're used.We've had that behaviour for 4 months now, and it's time to cut the old behaviour.
With this change, only the new environment variable names will be accepted, and trying to use the old names will result in your argument not being recognised.
Closes #856.
ThirdPartyNotices.txt(if applicable)