search

aws / aws-sdk-js

AWS SDK for JavaScript in the browser and Node.js
https://aws.amazon.com/developer/language/javascript/
Apache License 2.0
7.59k stars 1.55k forks source link

AWS SDK for JavaScript v2 Upcoming End-of-Support #4601

Closed trivikr closed 2 weeks ago

trivikr commented 6 months ago

We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

The AWS SDK for JavaScript v2 will reach:

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

MubashirullahD commented 3 months ago

As a new installer of v2, I wanted to jump straight to V3, but got confused since the information I wanted wasn't readily available. After some searching, here is how you install V3 as a new user.

Install the SDK for JavaScript

Not all services are immediately available in the SDK or in all AWS Regions.

To install a service from the AWS SDK for JavaScript using npm, the Node.js package manager, enter the following command at the command prompt, where SERVICE is the name of a service, such as s3.

npm install @aws-sdk/client-SERVICE For a full list of the AWS SDK for JavaScript service client packages, see the AWS SDK for JavaScript API Reference guide.

Developer Guide - Setting Up

OlivierJM commented 3 months ago

This should definitely be added to the readme or somewhere easily accessible.

trivikr commented 3 months ago

This should definitely be added to the readme or somewhere easily accessible.

The link to blog post is the first sentence in the first paragraph of the README added in https://github.com/aws/aws-sdk-js/pull/4598

This issue is also pinned to the top.

The announcement is also in all the pages of the Developer Guide, API Reference and a post install warning for npm

Is there some other way it can be made accessible?

OlivierJM commented 3 months ago

The announcement itself isn't the issue, the information provided by @MubashirullahD is what is not clear in all those documentations You have to dig to find that, I don't see any problem specifying in the Readme that to install the newer version you do npm install @aws-sdk/client-SERVICE instead of just providing codemod(which is nice to have)

trivikr commented 3 months ago

We point to the official blog post as the source of truth from all sources. The initial two paragraphs of the blog post have to explain what's the impact of the maintenance mode is going to be. Once that's explained the third paragraph points to Developer Guide of v3, which folks can refer to, if they're impacted and want to upgrade. The link to codemod appears much later.

If we provide install instructions for v3 directly from v2 README, it can cause confusion among customers of v2.

OlivierJM commented 3 months ago

Got it.