Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 9, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89392ae
chore(sdk-node): Add transition perioud notice and migration info
wobsoriano Oct 8, 2024
767bd5c
chore: add changeset
wobsoriano Oct 8, 2024
a1b79d3
chore: log deprecation notice
wobsoriano Oct 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/neat-wasps-explain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-sdk-node": patch
---

Add transition period notice and migration info
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

@wobsoriano wobsoriano Oct 8, 2024

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

# or
yarn add @clerk/clerk-sdk-node
yarn add @clerk/backend
# or
pnpm add @clerk/clerk-sdk-node
pnpm add @clerk/backend
```

## 🎓 Learning Clerk
Expand Down
3 changes: 3 additions & 0 deletions packages/sdk-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@

</div>

> [!IMPORTANT]
> 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).

## Getting Started

[Clerk](https://clerk.com/?utm_source=github&utm_medium=clerk_sdk_node) is the easiest way to add authentication and user management to your Node.js application. Add sign up, sign in, and profile management to your application in minutes.
Expand Down
6 changes: 6 additions & 0 deletions packages/sdk-node/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,9 @@ export { createClerkExpressRequireAuth, createClerkExpressWithAuth };

export { requireAuth } from './requireAuth';
export { withAuth } from './withAuth';

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',
);
Loading