LTS support definition #3
Conversation
sheplu
force-pushed
the
support-version
branch
2 times, most recently
from
19ab25b
to
7506c07
Compare
sheplu
force-pushed
the
support-version
branch
from
7506c07
to
3e25b12
Compare
| As of the date of this PR (March 1st 2024), the only released and maintained version of Express.js is the v4. | ||
| This version was created and published in 2014 and is supporting (working on) all Node.js version between 0.10 and 21.x - with tests run against all of them. | ||
|
|
||
| During the conception phase of Express v5 it was discussed to drop the support of all version below Node.js v4 (released in September 2015) - so supporting all versions from Node.js 4.x to Node.js 21.x, representing 18 versions. |
There was a problem hiding this comment.
any particular reason to stick with 4.x, if v5 wasn't released yet, and hence dropping versions wouldn't be extra breaking change?
There was a problem hiding this comment.
this is the point I want to raise, and basically, the best for me would be
- only support LTS version (18+) but it may be too radical
- so maybe choose to support v14+
|
|
||
| ## Long Term Support | ||
|
|
||
| Express Long Term Support (LTS) version is provided as per defined in this document - and also include all the packages part of the Express.js Organization (express, pillarjs and jshttp). |
There was a problem hiding this comment.
Just to clarify, all packages will need to start following this and not just express?
There was a problem hiding this comment.
All packages would need to provide this as a minimum, I’d assume - but they could certainly support longer if desired, since it’ll probably be cheap for smaller packages to do so.
There was a problem hiding this comment.
I think it is really important we clarify this. I think I subtly disagree with @ljharb on this, but so far the docs themselves do not provide enough clarity to have that conversation imo and I think we didn't have that discussion in the other original thread either. I will open an issue in the discussions repo so we can address that. We should block merging this on resolution to that discussion.
|
|
||
| Express Long Term Support (LTS) version is provided as per defined in this document - and also include all the packages part of the Express.js Organization (express, pillarjs and jshttp). | ||
|
|
||
| 1. Express follows a semantic versioning A.B.C (also know as semver), where the major version is represented by "A". Major version are supported for a minimal time of a year (as seen as 365 days). |
There was a problem hiding this comment.
And this is to say every major version is supported a minimum of 1 year? SGTM. My first reading of this doc was a bit confusing because it made it sound like we'll want to do releases every year, the language in Fastify is a bit clearer and helped me understand the intent of this doc.
|
|
||
| 1. Express follows a semantic versioning A.B.C (also know as semver), where the major version is represented by "A". Major version are supported for a minimal time of a year (as seen as 365 days). | ||
|
|
||
| 2. After the time that a LTS version (that can exceed one year) is maintained, the version will move to a maintenance mode during which only security patches will be released. This maintenance mode will be supported for at least one year. |
There was a problem hiding this comment.
I think the Fastify doc is clearer here too, you're basically saying after a new major version is released, the old one goes into LTS and supported for 1 year?
|
|
||
| > In specific case, a version in maintenance mode may require a breaking change to fix a security risk. If this happen, then it will be released as a minor version change but outlined in the release message | ||
|
|
||
| 3. Major version will be tested against all the LTS versions that were active during the time of the major version. This doesn't mean that the package won't support previous versions, but no tests will be run against them. |
There was a problem hiding this comment.
Is the LTS here being used to refer to the node.js LTS version and not this doc anymore?
|
|
||
| ## Express Releases | ||
|
|
||
| | Express version | Release | Maintenance | End of Life | Supported Node.js version | |
There was a problem hiding this comment.
Maintenance seems redundant if I'm reading this doc correctly, anything not the latest version would be in maintenance?
| For example, 20 was created in April 2023, moved to LTS in September 2023 and will be in maintenant mode until October 20224 and will run until April 2026. | ||
|
|
||
| Express and the ecosystem should follow versions that are not a security risk and keep being updated and patched as a primary support. | ||
| It is possible to have some breaking changes between major versions but in the past couple years, it was mostly minimal. |
There was a problem hiding this comment.
What is this sentence referring to? Express or node.js breaking changes?
|
|
||
| ### Node.js version supported | ||
|
|
||
| As a first point, the Express.js project should only support non-LTS version during their active phase and remove all specific compatibilities when they move out of active status - allowing us to use them as "trial" before the next LTS. |
There was a problem hiding this comment.
I don't follow this either, what does LTS refer to? Is it saying express should support only new versions during development and not the node.js LTS? What's the trial?
|
@ctcpip are we able to update this PR with your proposed changes? Since we merged the website update for the HeroDevs stuff, I would love if we could point folks to a plan here which we have resolved and committed to. |
|
@wesleytodd @ctcpip I will spend some time on monday to update it and take into account all previous comments but feel free to ping me directly on slack or just add changes here and I will add them |
|
@sheplu Can I help? |
|
@kibertoad of course! can be through issues or we can find some time tomorrow if you prefer :) |
|
@sheplu Async via issues would be easier, I reckon |
First PR to try to standardize how we define LTS and what it means for the Express.js ecosystem, including a first proposal for our releases and support - the value (one year) are a suggestion of my part and are here to be discussed
Inspired from the LTS definition of Fastify