Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 488bbe6

Browse files
authored
chore: add stability policy to SDK docs (awslabs#614)
1 parent 4f6f309 commit 488bbe6

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The **AWS SDK for Swift** is a pure Swift SDK for AWS services.
44

5-
**WARNING: Releases prior to 1.0.0 may contain bugs and no guarantee is made about API stability. They are not intended for use in production!**
5+
**The AWS SDK for Swift is currently in developer preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads. Refer to the SDK [stability](docs/stability.md) guidelines for more detail.**
66

77
## License
88

docs/stability.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Stability of the AWS SDK for Swift
2+
3+
For information about maintenance and support of SDK major versions and their underlying dependencies, see the
4+
following in the AWS SDKs and Tools Shared Configuration and Credentials Reference Guide:
5+
6+
* [AWS SDKs and Tools Maintenance Policy](https://docs.aws.amazon.com/credref/latest/refdocs/maint-policy.html)
7+
* [AWS SDKs and Tools Version Support Matrix](https://docs.aws.amazon.com/credref/latest/refdocs/version-support-matrix.html)
8+
9+
## Qualifiers
10+
11+
Qualifiers for published artifacts
12+
13+
**`-alpha`** indicates:
14+
15+
* The SDK is not meant for production workloads. It is released solely for the purpose of getting feedback.
16+
* The SDK is not yet feature complete. It may contain bugs and performance issues.
17+
* Expect migration issues as APIs/types change.
18+
19+
**`-beta`** indicates:
20+
21+
* The SDK is not meant for production workloads.
22+
* The SDK is feature complete. It may still contain bugs and performance issues.
23+
* The APIs/types are mostly stabilized. It is still possible that future releases may cause migration issues.
24+
25+
NOTE: This corresponds to the "Developer Preview" phase of the maintenance policy linked above.

0 commit comments

Comments
 (0)