Skip to content

Commit b0bfb28

Browse files
authored
Update README with v2 end-of-support announcement (#4597)
1 parent eda0c49 commit b0bfb28

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Support",
4+
"description": "Update README with v2 end-of-support announcement"
5+
}

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,13 @@
88
[![Coverage Status](https://codecov.io/gh/aws/aws-sdk-js/branch/master/graph/badge.svg)](https://codecov.io/gh/aws/aws-sdk-js)
99
[![Known Vulnerabilities](https://snyk.io/test/github/aws/aws-sdk-js/badge.svg)](https://snyk.io/test/github/aws/aws-sdk-js)
1010

11-
## Version 3.x Now Available
12-
The [version 3.x](https://github.com/aws/aws-sdk-js-v3) of the AWS SDK for JavaScript is generally available.
13-
For more information see the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/)
14-
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
11+
## Version 2.x End-of-Support
1512

16-
For release notes, see the [CHANGELOG](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md). Prior to v2.4.8, release notes can be found at https://aws.amazon.com/releasenotes/?tag=releasenotes%23keywords%23javascript
13+
We [announced][v2-maintenance-mode] the upcoming end-of-support for AWS SDK for JavaScript v2.
14+
We recommend that you migrate to [AWS SDK for JavaScript v3][aws-sdk-js-v3].
15+
For dates, additional details, and information on how to migrate, please refer to the linked announcement.
1716

18-
## Version 2.x Support
19-
We are formalizing our plans to make the *Maintenance Announcement (Phase 2)* for **AWS SDK for JavaScript v2** in early 2024.
20-
Please refer to the [AWS SDKs and Tools maintenance policy][aws-sdks-maintenance-policy] for further details.
21-
22-
[**AWS SDK for JavaScript v3**][aws-sdk-js-v3] is the latest and recommended version,
17+
The **AWS SDK for JavaScript v3** is the latest and recommended version,
2318
which has been GA since December 2020. Here is [why and how you should use
2419
**AWS SDK for JavaScript v3**][v3-recommended-blog]. You can try our experimental
2520
migration scripts in [aws-sdk-js-codemod][aws-sdk-js-codemod] to migrate
@@ -47,11 +42,11 @@ require('aws-sdk/lib/maintenance_mode_message').suppress = true;
4742
```
4843

4944
[v2-new-issue]: https://github.com/aws/aws-sdk-js/issues/new/choose
45+
[v2-maintenance-mode]: https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-javascript-v2
5046
[v3-recommended-blog]: https://aws.amazon.com/blogs/developer/why-and-how-you-should-use-aws-sdk-for-javascript-v3-on-node-js-18/
5147
[v3-contributing]: https://github.com/aws/aws-sdk-js-v3#giving-feedback-and-contributing
52-
[aws-sdk-js-v3]: https://github.com/aws/aws-sdk-js-v3
48+
[aws-sdk-js-v3]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html
5349
[aws-devtools-blog]: https://aws.amazon.com/blogs/developer/
54-
[aws-sdks-maintenance-policy]: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html
5550
[open-issue-v2-guidance]: https://github.com/aws/aws-sdk-js/issues/new?assignees=&labels=guidance%2C+needs-triage&template=---questions---help.md&title=
5651
[aws-sdk-js-codemod]: https://www.npmjs.com/package/aws-sdk-js-codemod
5752

0 commit comments

Comments
 (0)