Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add info about stability to repo README #9691

Merged
merged 7 commits into from
Aug 14, 2020
Merged

docs: Add info about stability to repo README #9691

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1296465
Update README.md
Aug 13, 2020
2a23c94
capitalize Stable to match Experimental
Aug 13, 2020
4abf737
Update README.md
Aug 14, 2020
def57e4
Merge branch 'master' into versioning-README
Aug 14, 2020
e28aa88
Add mention of where to find stability designation and link
Aug 14, 2020
e0693d3
Use AWS CDK rather than just CDK
Aug 14, 2020
bac2585
Merge branch 'master' into versioning-README
mergify[bot] Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ how to use AWS. The AWS Construct Library aims to reduce the complexity and
glue-logic required when integrating various AWS services to achieve your goals
on AWS.

Modules in the AWS Construct Library are designated Experimental while we build
This conversation was marked as resolved.
Show resolved Hide resolved
them; experimental modules may have breaking API changes in any release. After
a module is designated Stable, it adheres to [semantic versioning](https://semver.org/),
and only major releases can have breaking changes. Each module's stability designation
is available on its Overview page in the [AWS CDK API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html).
For more information, see [Versioning](https://docs.aws.amazon.com/cdk/latest/guide/reference.html#versioning)
in the CDK Developer Guide.

[CDK framework]: https://docs.aws.amazon.com/cdk/latest/guide/home.html
[constructs]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html
[stacks]: https://docs.aws.amazon.com/cdk/latest/guide/stacks.html
Expand Down