feat(express): Support Express v5 #4201
Conversation
🦋 Changeset detectedLatest commit: 83c09a2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
| @@ -68,6 +68,9 @@ | |||
| "tsup": "*", | |||
| "typescript": "*" | |||
| }, | |||
| "peerDependencies": { | |||
| "express": "^4.17.0 || ^5.0.0" | |||
There was a problem hiding this comment.
we support v5 out-of-the-box actually but we want to set a more stable minimum v4 version to prevent any breaking change in earlier versions
There was a problem hiding this comment.
@clerk/express is still v0. Are we doing v1 after this PR, or we wait for Express 5 to be cut as latest and then do v1 ?
There was a problem hiding this comment.
Lets do v1 now unless we know that express v5 is coming out soon
There was a problem hiding this comment.
For reference, here's the pending items before they tag v5 as latest:
Mostly docs update, so I think latest tag will come soon. Let's go v1 major? v5 is backwards compatible anyway...
.changeset/three-falcons-glow.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| --- | |||
| "@clerk/express": patch | |||
There was a problem hiding this comment.
I think minor is more appropriate
| "@clerk/express": patch | |
| "@clerk/express": minor |
There was a problem hiding this comment.
Updated to major since Express v5 tagged as latest will come sooner than later anyway and that we can start deprecating @clerk/clerk-sdk-node too (migration PR docs already in review). What y'all think?
| @@ -68,6 +68,9 @@ | |||
| "tsup": "*", | |||
| "typescript": "*" | |||
| }, | |||
| "peerDependencies": { | |||
| "express": "^4.17.0 || ^5.0.0" | |||
There was a problem hiding this comment.
Lets do v1 now unless we know that express v5 is coming out soon
Description
This PR sets a minimum Express 4 version and support for Express 5.
For Express
^4.17.0- we went with this version as it's a more stable version, to avoid issues with earlier 4.x.x releases. We didn't want to start all the way back at 4.0.0 and risk running into old bugs or outdated features.Here's the total downloads of
4.17.x:For v5, there is not really a big breaking change and it aims to support backward compatibility with Express 4. Here's a small breaking note that should not affect our SDK. Full changelog can be found here if interested.
Note that Express v5 is still tagged as
nextand notlatesteven though it's stable. But we want to add support to it now as we don't want to release another major change in the future.I tested v5 locally with our current CI test and it passed.
This is part of making our Express SDK ready.
Resolves ECO-192
Checklist
npm testruns as expected.npm run buildruns as expected.Type of change