Skip to content

Commit eb5fabb

Browse files
authored
chore(readme): release cadence, modular package stability (#4199)
1 parent 3a4588f commit eb5fabb

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).
4242
1. [Middleware Stack](#middleware-stack)
4343
1. [Install from Source](#install-from-source)
4444
1. [Giving feedback and contributing](#giving-feedback-and-contributing)
45+
1. [Release Cadence](#release-cadence)
46+
1. [Stability of Modular Packages](#stability-of-modular-packages)
4547
1. [Known Issues](#known-issues)
4648
1. [Functionality requiring AWS Common Runtime (CRT)](#functionality-requiring-aws-common-runtime-crt)
4749

@@ -507,6 +509,30 @@ client.middlewareStack.add(middleware, {
507509

508510
For a full middleware stack deep dive please check out our [blog post](https://aws.amazon.com/blogs/developer/middleware-stack-modular-aws-sdk-js/).
509511

512+
## Release Cadence
513+
514+
Our releases usually happen once per weekday. Each release increments the
515+
minor version, e.g. 3.200.0 -> 3.201.0.
516+
517+
## Stability of Modular Packages
518+
519+
|Package name|containing folder|API controlled by|stability|
520+
|---|---|---|---|
521+
|@aws-sdk/client-* Commands|clients|AWS service teams|public/stable|
522+
|@aws-sdk/client-* Clients|clients|AWS SDK JS team|public/stable|
523+
|@aws-sdk/lib-*|lib|AWS SDK JS team|public/stable|
524+
|@aws-sdk/*-signer|packages|AWS SDK JS team|public/stable|
525+
|@aws-sdk/middleware-stack|packages|AWS SDK JS team|public/stable|
526+
|remaining @aws-sdk/*|packages|AWS SDK JS team|internal|
527+
528+
Additional notes:
529+
- internal does not mean a package or interface is constantly changing
530+
or being actively worked on. It means it is subject to change without any
531+
notice period. The changes are included in the release notes.
532+
- public interfaces such as client configuration are also subject to change
533+
in exceptional cases. We will try to undergo a deprecation period with
534+
an advance notice.
535+
510536
## Known Issues
511537

512538
### Functionality requiring AWS Common Runtime (CRT)

0 commit comments

Comments
 (0)