-
Notifications
You must be signed in to change notification settings - Fork 64
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
9fda40a
to
733334b
Compare
packages/kv/README.md
Outdated
# @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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
packages/postgres/README.md
Outdated
# @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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need to deprecate https://github.com/vercel/storage/tree/main/packages/postgres-kysely as well?
There was a problem hiding this comment.
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.
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.