refactor!: Improve Mappings helper function(s) #387
Merged
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
BREAKING CHANGE: The `setStageDependentValue` and `getStageDependentValue` helper functions have been removed. In order to reduce boilerplate, the same functionality is now provided via a single function (`withStageDependentValue`).
cc @mbarton as I think you might be the only affected user so far! It would be good to know if you think that this is an improvement or not. |
mbarton
approved these changes
Apr 6, 2021
akash1810
approved these changes
Apr 6, 2021
|
🎉 This PR is included in version 7.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
What does this change?
The
setStageDependentValueandgetStageDependentValuehelper functions have been removed. In order to reduce boilerplate, the same functionality is now provided via a single function (withStageDependentValue).Does this change require changes to existing projects or CDK CLI?
Yes, this is a breaking change. Stacks which use
setStageDependentValueandgetStageDependentValuedirectly will need to usewithStageDependentValueinstead. Stacks which use this functionality via the ASG construct should be unaffected.How to test
Existing ASG unit tests already validate this behaviour (and they still pass!).
How can we measure success?
Have we considered potential risks?
As mentioned above, this is a breaking change. However, as this functionality is not widely adopted yet I think it's relatively low risk to make the change at this early stage of development.