chore: Update README prerequisites #9295
Conversation
| * we generally support the latest LTS release: use [nvm](https://github.com/nvm-sh/nvm) to keep your local system up-to-date | ||
| * Yarn (`npm install -g yarn`) | ||
| * gcc-10 or newer, or a compiler with `__has_builtin()` | ||
| * gcc >=10, clang >=10, or another compiler with `__has_builtin()` |
There was a problem hiding this comment.
clang 10 is very old, but consistent with our releases.
Deploying agoric-sdk with
|
| Latest commit: |
9f934bf
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8a2f786e.agoric-sdk.pages.dev |
| Branch Preview URL: | https://gibson-9294-prerequisites.agoric-sdk.pages.dev |
gibson042
force-pushed
the
gibson-9294-prerequisites
branch
from
8019441
to
380c068
Compare
gibson042
changed the title
| @@ -17,10 +17,11 @@ to use. | |||
| ## Prerequisites | |||
|
|
|||
| * Git | |||
| * Node.js LTS (version 16.13.0 or higher) | |||
| * Go ^1.20.2 | |||
| * Node.js ^18.12 or ^20.9 | |||
There was a problem hiding this comment.
the policy is Node LTS, whatever that may be. let's leave specific version numbers out of the README.
though consider linking from here to https://github.com/Agoric/agoric-sdk/blob/master/docs/node-version.md
There was a problem hiding this comment.
Hmm, does that make sense in a list that is specific with respect to other software? I think instead it makes sense to have the README be the source of truth and docs/node-version.md to include instructions for updating it in accordance with Node.js LTS policy. We shouldn't expect someone to be able to use a Node.js version that we haven't actively vetted, even if it is LTS.
There was a problem hiding this comment.
I agree with @gibson042, there is a difference between policy, and what is actually tested. The goal of this section is also to be referenced from release notes by permalink, so we should have an explicit statement of what versions are explicitly supported and tested.
There was a problem hiding this comment.
I think instead it makes sense to have the README be the source of truth and docs/node-version.md to include instructions for updating it in accordance with Node.js LTS policy
I'm not concerned with which doc is the source of truth, but that any doc is rather than CI or package.json engines which is the actual truth about what is supported. I'm weary of multiple sources of "truth" and the likelihood they get out so sync.
Take that input fwiw. No objections to the PR as is.
Fixes #9294
Description
Update the master README for Node.js v18/v20 and Go 1.20+.
Security Considerations
None.
Scaling Considerations
n/a
Documentation Considerations
This presumes that README.md is the source of truth as suggested in #9294.
Testing Considerations
n/a
Upgrade Considerations
Release commits are expected to have a static snapshot as relevant to them (e.g., release-mainnet1B does not support Node.js v20 AFAIK).