Repository navigation
Explicitly document supported Node & Python versions per major release in README #2948
Description
Many users encounter confusing errors because they are using older versions of node-gyp being required by other dependencies. However, some developers, including myself, are hesitant to explicitly resolve to a higher version of node-gyp as it may introduce new compatibility issues, e.g. older versions of Node or Python being dropped.
Can the supported Python & Node versions per major release be explicitly documented in the README? For example, one row may look like:
| node-gyp version | Compatible Python versions | Compatible Node versions |
|---|---|---|
| ^9.0.0 | >=3.7,<=3.10 | >=12,<=18 |
Activity
cclauss commentedon Nov 13, 2023
Python v3.12requiresnode-gyprelease >= v10.Apollon77 commentedon Nov 13, 2023
... and is included in npm >= 10.2.2. Maybe adding that would also be awesome
dlqqq commentedon Nov 13, 2023
@cclauss Thanks for clarifying the behavior of
node-gyp@^10! I have another follow-up question for you.I believe the current major release policy is as follows:
node-gypand cut a release.Is the observed major release policy for
node-gyp? If not, what is the major release policy? We should also cover this in the documentation.cclauss commentedon Nov 13, 2023
My efforts on the Python side is that the current
node-gyptracks with https://devguide.python.org/versionsThat means that
node-gypv10 supports Python 3.8 thru 3.12. Supporting five versions seems like enough complexity.Node.js support should similarly track with https://nodejs.org/en/about/previous-releases
dlqqq commentedon Nov 13, 2023
@cclauss That makes sense, thanks for the reference! I am asking, however, what goes into deciding whether to cut a new major release? For example, did you cut
node-gyp@^10because Python 3.12 was released, or for some other reason?I think the repository needs a major release policy to be explicitly documented. In other words, there should be documentation that describes when and why new major releases of
node-gypare cut.cclauss commentedon Nov 13, 2023
Is a good example of the kind of discussion that goes into making a major release.