diff options
| author | Rod Vagg <rod@vagg.org> | 2018-11-06 13:40:03 +1100 |
|---|---|---|
| committer | Rod Vagg <rod@vagg.org> | 2019-04-17 20:28:04 +1000 |
| commit | c61c722c8cbaa548bf0342bb1bd13ed64474faeb (patch) | |
| tree | 7bc5acc16c4b6d6ac92d666fe946099ceb410552 /doc/releases.md | |
| parent | cdba9f23ec301f834ac686df7e6adcc3ecf59db6 (diff) | |
| download | node-new-c61c722c8cbaa548bf0342bb1bd13ed64474faeb.tar.gz | |
doc: add ABI version registry
PR-URL: https://github.com/nodejs/node/pull/24114
Refs: https://nodejs.org/en/download/releases/
Refs: https://github.com/lgeiger/node-abi/blob/master/index.js
Refs: https://github.com/nodejs/TSC/issues/621
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Ujjwal Sharma <usharma1998@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Diffstat (limited to 'doc/releases.md')
| -rw-r--r-- | doc/releases.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/releases.md b/doc/releases.md index b03c623ecf..483b1f030c 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -235,6 +235,12 @@ and also if there are non-trivial API changes. The rules are not yet strictly defined, so if in doubt, please confer with someone that will have a more informed perspective, such as a member of the NAN team. +A registry of currently used `NODE_MODULE_VERSION` values is maintained at +<https://github.com/nodejs/node/blob/master/doc/abi_version_registry.json>. +When bumping `NODE_MODULE_VERSION`, you should choose a new value not listed +in the registry. Also include a change to the registry in your commit to +reflect the newly used value. + It is current TSC policy to bump major version when ABI changes. If you see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC. Commits may need to be reverted or a major version bump may need to happen. |