Document Wrangler's OS & Node support policy #17513
Conversation
penalosa
requested review from
petebacondarwin,
dario-piotrowicz,
irvinebroque,
GregBrimble and
a team
as code owners
github-actions
bot
assigned dario-piotrowicz, GregBrimble, irvinebroque and petebacondarwin
|
|
||
| Wrangler supports the [Current, Active, and Maintenance](https://nodejs.org/en/about/previous-releases) versions of Node.js. We aim not to break older versions of Node.js, but occasionally will due to features that are unavailable in older version of Node.js or security patches. | ||
|
|
||
| For most Wrangler features to work, your operating system needs to support `workerd`, the open source Cloudflare Workers runtime. `workerd`'s OS support policy is listed in it's [GitHub README](https://github.com/cloudflare/workerd?tab=readme-ov-file#running-workerd). |
There was a problem hiding this comment.
Can we just state this upfront here, rather than linking somewhere else? And simplify?
This doesn't include Windows, should it?
|
|
||
| <Details header="Wrangler System Requirements"> | ||
|
|
||
| Wrangler supports the [Current, Active, and Maintenance](https://nodejs.org/en/about/previous-releases) versions of Node.js. We aim not to break older versions of Node.js, but occasionally will due to features that are unavailable in older version of Node.js or security patches. |
There was a problem hiding this comment.
Can we be explicit that we are talking about the requirements of the CLI and not the requirements of your application?
Just thinking about how people can easily assume their app is running Node.js.
|
@irvinebroque I've reworded—how does that look? |
There was a problem hiding this comment.
Up to this point, wrangler has advertised support for Node.js 16+.
While I’m generally in favour of a change like this, allowing wrangler to target newer ecosystem features, I feel that a v4 needs to be cut to drop Node.js 16 support and move over to this new policy moving forward?
|
Hi 👋, I have to agree with James here. This is a solution we've discussed on Discord before, and even though it's the one I'd choose personally (as opposed to bumping major just for minimum supported nodejs even when nothing would break, which is marginally safer but look at the adoption of ts 4.9 vs ts 5.0 even though 4.9 was no less breaking), it's one that is not compatible with the current version's policy - 16.13.0 has been explicitly mentioned in a lot of docs. Fortunately, if the only breaking changes are to use a more recent nodejs version, and hopefully an esbuild bump (and the natural removal of some deprecated features), it will be a much easier migration for most people 🤞and the aforementioned version fragmentation won't be as bad. The longer deprecated v3 features are kept in the code/docs, the worse the migration will be, when the time comes. |
|
Closing for now. We'll still do this, but it'll be part of the v4 updates: cloudflare/workers-sdk#7334 |
Summary
This adds a documented OS and Node version support policy for Wrangler, which we didn't previously have explicitly documented.
The Node version support policy is potentially controversial.