fix: Mark GuKinesisLambda and GuSnsLambda patterns as alpha
#1293
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
The shape of the incoming props, specifically around handling of an existing resource, is likely to be changed over time as we understand use-cases. So, annotate these patterns as `alpha`.
2 tasks
|
🎉 This PR is included in version 43.4.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 shape of the incoming props, specifically around handling of an existing resource, is likely to be changed over time as we understand use-cases. So, annotate these patterns as
alpha.See these attempts to update the incoming props:
migratedFromCloudFormationprop onGuStack#1278 (comment)Although TypeDoc doesn't support
@alphait does at least standout:TSDoc seems to support a wider range of tags, but not sure it's worth moving just yet.
How to test
n/a
How can we measure success?
Permission to break the API in future releases 🤞🏽 ?
Have we considered potential risks?
Across the org, there is only one use of
GuSnsLambda, this is in a DevX owned repo. That is, the risk of having an unstable API isn't really a reality yet.Checklist
Footnotes
Consider whether this is something that will mean changes to projects that have already been migrated, or to the CDK CLI tool. If changes are required, consider adding a checklist here and/or linking to related PRs. ↩
If you are adding a new construct or pattern, has new documentation been added? If you are amending defaults or changing behaviour, are the existing docs still valid? ↩