[spruce] Remove v0 code paths and references #181
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jhamon
approved these changes
Jan 8, 2024
v1-migration.md
Outdated
There was a problem hiding this comment.
I think we should keep this file, but update it a bit to reflect that the old code no longer works. Anyone still on the old code still needs guidance on how to migrate.
There was a problem hiding this comment.
Added it back for now, added a disclaimer at the top that's it's specific to the v0 -> v1 path. Also stubbed out the v2-migration.md file as I plan to work on it over the next couple days.
README.md
Outdated
| @@ -5,7 +5,6 @@ This is the official Node.js client for [Pinecone](https://www.pinecone.io), wri | |||
| ## Documentation | |||
|
|
|||
| - [**Reference Documentation**](https://sdk.pinecone.io/typescript/classes/Pinecone.html) | |||
| - If you are upgrading from a `v0.x` beta client, check out the [**v1 Migration Guide**](https://github.com/pinecone-io/pinecone-ts-client/blob/main/v1-migration.md). | |||
There was a problem hiding this comment.
As mentioned elsewhere, I would bring this back.
austin-denoble
force-pushed
the
adenoble/remove-v0-code-paths
branch
from
6a58199 to
5a4fb29
Compare
austin-denoble
added a commit
that referenced
this pull request
Jan 13, 2024
## Problem When we launched the node v1.0.0 client, we left in code paths, exports, and the generated core for the original v0 client. This was to facilitate ease of migration alongside a migration guide: `v1-migration.md`. As we move to release v2.0.0 we'd like to fully deprecate the v0 client. ## Solution - Remove everything under `/src/v0/` which includes the v0 client code and generated core. - Delete `README.v0.md` and `v1-migration.md`. - Remove references to v0 from `README.md`. - Remove v0 exports from `src/index.ts`. - Remove v0 environment requirements and code exports from `replInit.ts`. - Remove `isLegacy` from `buildUserAgent`. - Remove v0 paths and references from config files. ## Type of Change - [X] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [X] This change requires a documentation update ## Test Plan Verify CI and tests pass as expected. There should no longer be v0 exports present in the `Pinecone` package. Run the repl and make sure you're not seeing the legacy export: ``` $ npm run repl > @pinecone-database/[email protected] repl > npm run build && node utils/replInit.ts > @pinecone-database/[email protected] build > rm -rf dist/ && tsc INFO Found environment variable PINECONE_API_KEY in .env file > SUCCESS Pinecone module exports (Pinecone, etc) automatically imported to this repl session. Run "await init()" to setup client instance using environment variable configs. ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When we launched the node v1.0.0 client, we left in code paths, exports, and the generated core for the original v0 client. This was to facilitate ease of migration alongside a migration guide:
v1-migration.md.As we move to release v2.0.0 we'd like to fully deprecate the v0 client.
Solution
/src/v0/which includes the v0 client code and generated core.README.v0.mdandv1-migration.md.README.md.src/index.ts.replInit.ts.isLegacyfrombuildUserAgent.Type of Change
Test Plan
Verify CI and tests pass as expected. There should no longer be v0 exports present in the
Pineconepackage.Run the repl and make sure you're not seeing the legacy export: