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

[@vercel/kv, @vercel/postgres, @vercel/postgres-kysely] Add deprecation notice to READMEs #831

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

adriancooney
Copy link
Collaborator

@adriancooney adriancooney commented Feb 21, 2025

This PR adds deprecation notices to the READMEs of @vercel/kv, @vercel/postgres and @vercel/postgres-kysely. The Vercel KV and Vercel Postgres have transitioned over to Neon and Upstash in the Vercel Marketplace, unlocking the full potential of both platforms for Vercel customers. As a consequence, we are deprecating @vercel/kv in favour of Upstash's @upstash/redis module and @vercel/postgres in favour of Neon's @neondatabase/serverless. These modules were essentially just wrappers around these modules anyway (with some added bells and whistles and API sprinkles). npm deprecation notices will follow soon.

Copy link

changeset-bot bot commented Feb 21, 2025

⚠️ No Changeset found

Latest commit: c3cdff7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Feb 21, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
vercel-storage-next-integration-test-suite ✅ Ready (Inspect) Visit Preview Feb 24, 2025 10:47am

@adriancooney adriancooney requested a review from a team February 21, 2025 10:40
# @vercel/kv
# @vercel/kv (deprecated)

> [!CAUTION] > **`@vercel/kv` is deprecated**. Please use [the `@upstash/redis` package from Upstash instead](https://github.com/upstash/redis-js).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-02-21 at 12 05 16

it seems the Note didn't render correctly

Should we add some info about the features in this package not avilable in @upstash/redis?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grrr. My editor formatter removed the new line, very strange. Updated! Thanks for checking.

Should we add some info about the features in this package not avilable in @upstash/redis?

What had you in mind?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • this package overrides scan, hscanIterator, sscan, zscan...not sure if upstash fixed that issue in the meantime, otherwise we could mention it in the deprecation note

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you mean like an upgrade guide? I'll check in with the docs team to see where we are on that.

# @vercel/postgres
# @vercel/postgres (deprecated)

> [!CAUTION] > **`@vercel/postgres` is deprecated**. Please use [the `@neondatabase/serverless` package from Neon instead](https://github.com/neondatabase/serverless). See the [Vercel Postgres to Neon transition guide](https://neon.tech/docs/guides/vercel-postgres-transition-guide).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, apologies! I think I pushed an older commit.

@adriancooney adriancooney changed the title [@vercel/kv, @vercel/storage] Add deprecation notice to READMEs [@vercel/kv, @vercel/postgres, @vercel/postgres-kysely] Add deprecation notice to READMEs Feb 24, 2025
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

Successfully merging this pull request may close these issues.

2 participants