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

chore(clerk-sdk-node): Add transition period notice and migration info #4305

Merged

Conversation

wobsoriano
Copy link
Member

Description

This PR adds an EOL notice for @clerk/clerk-sdk-node and provides a link for migrating to @clerk/express

Resolves ECO-209

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Copy link

changeset-bot bot commented Oct 8, 2024

🦋 Changeset detected

Latest commit: a1b79d3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@clerk/clerk-sdk-node Patch

Not sure what this means? Click here to learn what changesets are.

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

@wobsoriano wobsoriano changed the title chore(sdk-node): Add transition perioud notice and migration info chore(sdk-node): Add transition period notice and migration info Oct 8, 2024
@@ -39,11 +39,11 @@ Would you like to work on Open Source software and help maintain this repository
This repository contains the SDKs for environment/platforms that Clerk supports. For example, if you want to use Clerk with Node.js you can install:

```sh
npm install @clerk/clerk-sdk-node
npm install @clerk/backend
Copy link
Member Author

Choose a reason for hiding this comment

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

We should recommend @clerk/backend for Node.js and Edge runtimes

@wobsoriano wobsoriano marked this pull request as ready for review October 8, 2024 23:06
@wobsoriano wobsoriano changed the title chore(sdk-node): Add transition period notice and migration info chore(clerk-sdk-node): Add transition period notice and migration info Oct 8, 2024
@anagstef
Copy link
Member

anagstef commented Oct 9, 2024

Maybe also add a console warning? 🤔

@wobsoriano
Copy link
Member Author

Maybe also add a console warning? 🤔

Added here

console.warn(
'Starting October 8, 2024, the Node SDK is entering a three-month notice period. ' +
'We encourage everyone to migrate to @clerk/express. ' +
'For full details, please see our changelog: https://clerk.com/changelog/2024-10-08-express-sdk',
);

@wobsoriano wobsoriano merged commit b0a85b4 into main Oct 9, 2024
21 checks passed
@wobsoriano wobsoriano deleted the rob/eco-209-add-transition-period-notice-to-sdk-node branch October 9, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants