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.

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

Documentation or Changelog Support for V1 Upgrade #396

Open
dvoigtcb opened this issue Jan 2, 2025 · 1 comment
Open

Documentation or Changelog Support for V1 Upgrade #396

dvoigtcb opened this issue Jan 2, 2025 · 1 comment

Comments

@dvoigtcb
Copy link

dvoigtcb commented Jan 2, 2025

When upgrading to Node version 20, I had to update this library to the latest version (v1) that supports AWS SDK V3. I've encountered several breaking changes, including changes to method names and some methods that appear to have been removed. Unfortunately, I haven't been able to find any documentation, such as a changelog, that describes these breaking changes and what needs to be updated.

In general, it seems there isn't a comprehensive place to check for documentation, aside from a brief introduction in the GitHub README and examining the source code.

Is there any existing documentation that describe all methods and/or a changelog? If not, I would be happy to contribute to developing this documentation, as this repository is heavily relied upon by many services.

@jgilbert01
Copy link
Owner

AWS SDK v3 had a lot of breaking changes and we did our best to hide these, mostly inside the connectors.
We couldn't hide them all, so we incremented the major version number.

We also took advantage of this major version number to make some breaking improvements:

  • we renamed some things for clarity
  • we removed duplicate/deprecated methods resulting from the renaming
  • we switched some less used features to path based imports to minimize the required dependencies for typical use cases

The following PRs are the best source for the changes:

There maybe smaller tweaks in other PRs.

Any contributions you would like to make are welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants