summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRod Vagg <rod@vagg.org>2018-11-06 13:40:03 +1100
committerRod Vagg <rod@vagg.org>2019-04-17 20:28:04 +1000
commitc61c722c8cbaa548bf0342bb1bd13ed64474faeb (patch)
tree7bc5acc16c4b6d6ac92d666fe946099ceb410552 /doc
parentcdba9f23ec301f834ac686df7e6adcc3ecf59db6 (diff)
downloadandroid-node-v8-c61c722c8cbaa548bf0342bb1bd13ed64474faeb.tar.gz
android-node-v8-c61c722c8cbaa548bf0342bb1bd13ed64474faeb.tar.bz2
android-node-v8-c61c722c8cbaa548bf0342bb1bd13ed64474faeb.zip
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')
-rw-r--r--doc/abi_version_registry.json58
-rw-r--r--doc/releases.md6
2 files changed, 64 insertions, 0 deletions
diff --git a/doc/abi_version_registry.json b/doc/abi_version_registry.json
new file mode 100644
index 0000000000..06a976d9af
--- /dev/null
+++ b/doc/abi_version_registry.json
@@ -0,0 +1,58 @@
+{
+ "NODE_MODULE_VERSION": [
+ { "modules": 72, "runtime": "node", "variant": "v8_7.4", "versions": "12.0.0-pre" },
+ { "modules": 71, "runtime": "node", "variant": "v8_7.3", "versions": "12.0.0-pre" },
+ { "modules": 70, "runtime": "electron", "variant": "electron", "versions": "5" },
+ { "modules": 69, "runtime": "electron", "variant": "electron", "versions": "^4.0.5" },
+ { "modules": 68, "runtime": "node", "variant": "v8_7.1", "versions": "12.0.0-pre" },
+ { "modules": 67, "runtime": "node", "variant": "node", "versions": "11" },
+ { "modules": 66, "runtime": "node", "variant": "v8_6.9", "versions": "11.0.0-pre" },
+ { "modules": 65, "runtime": "node", "variant": "v8_6.8", "versions": "11.0.0-pre" },
+ { "modules": 65, "runtime": "node", "variant": "debian-openssl_1.1.1", "versions": "10" },
+ { "modules": 64, "runtime": "node", "variant": "node", "versions": "10" },
+ { "modules": 64, "runtime": "electron", "variant": "electron", "versions": ">=3 <4.0.5" },
+ { "modules": 63, "runtime": "node", "variant": "v8_6.6", "versions": "10.0.0-pre" },
+ { "modules": 62, "runtime": "node", "variant": "v8_6.5", "versions": "10.0.0-pre" },
+ { "modules": 61, "runtime": "node", "variant": "v8_6.4", "versions": "10.0.0-pre" },
+ { "modules": 60, "runtime": "node", "variant": "v8_6.3", "versions": "10.0.0-pre" },
+ { "modules": 59, "runtime": "node", "variant": "node", "versions": "9" },
+ { "modules": 59, "runtime": "nw.js", "variant": "nw.js", "versions": "~0.26.5" },
+ { "modules": 58, "runtime": "node", "variant": "v8_6.1", "versions": "9.0.0-pre" },
+ { "modules": 58, "runtime": "node", "variant": "debian-openssl_1.1.1", "versions": "8" },
+ { "modules": 57, "runtime": "node", "variant": "node", "versions": "8" },
+ { "modules": 57, "runtime": "electron", "variant": "electron", "versions": ">=1.8 <3" },
+ { "modules": 57, "runtime": "nw.js", "variant": "nw.js", "versions": ">=0.23 <0.26.5" },
+ { "modules": 56, "runtime": "node", "variant": "v8_5.9", "versions": "8.0.0-pre" },
+ { "modules": 55, "runtime": "node", "variant": "v8_5.8", "versions": "8.0.0-pre" },
+ { "modules": 54, "runtime": "node", "variant": "v8_5.7", "versions": "8.0.0-pre" },
+ { "modules": 54, "runtime": "electron", "variant": "electron", "versions": "1.7" },
+ { "modules": 53, "runtime": "node", "variant": "v8_5.6", "versions": "8.0.0-pre" },
+ { "modules": 53, "runtime": "electron", "variant": "electron", "versions": "1.6" },
+ { "modules": 52, "runtime": "node", "variant": "v8_5.5", "versions": "8.0.0-pre" },
+ { "modules": 51, "runtime": "node", "variant": "node", "versions": "7" },
+ { "modules": 51, "runtime": "electron", "variant": "electron", "versions": "1.5" },
+ { "modules": 51, "runtime": "nw.js", "variant": "nw.js", "versions": ">=0.18.3 <0.24" },
+ { "modules": 50, "runtime": "electron", "variant": "electron", "versions": "1.4" },
+ { "modules": 49, "runtime": "electron", "variant": "electron", "versions": "1.3" },
+ { "modules": 48, "runtime": "node", "variant": "node", "versions": "6" },
+ { "modules": 48, "runtime": "electron", "variant": "electron", "versions": ">1.1 <1.3" },
+ { "modules": 48, "runtime": "nw.js", "variant": "nw.js", "versions": "6" },
+ { "modules": 47, "runtime": "node", "variant": "node", "versions": "5" },
+ { "modules": 47, "runtime": "electron", "variant": "electron", "versions": "0.36" },
+ { "modules": 47, "runtime": "nw.js", "variant": "nw.js", "versions": "0.13" },
+ { "modules": 46, "runtime": "node", "variant": "node", "versions": "4" },
+ { "modules": 46, "runtime": "electron", "variant": "electron", "versions": ">=0.33 <0.36" },
+ { "modules": 45, "runtime": "node", "variant": "io.js", "versions": "3" },
+ { "modules": 45, "runtime": "electron", "variant": "electron", "versions": ">=0.31 <0.33" },
+ { "modules": 44, "runtime": "node", "variant": "io.js", "versions": "2" },
+ { "modules": 44, "runtime": "electron", "variant": "electron", "versions": "0.30" },
+ { "modules": 43, "runtime": "node", "variant": "io.js", "versions": ">=1.1 <2" },
+ { "modules": 42, "runtime": "node", "variant": "io.js", "versions": "1.0" },
+ { "modules": 14, "runtime": "node", "variant": "node", "versions": ">=0.11.11 <0.13" },
+ { "modules": 13, "runtime": "node", "variant": "node", "versions": ">=0.11.8 <0.11.11" },
+ { "modules": 12, "runtime": "node", "variant": "node", "versions": ">=0.11.0 <0.11.8" },
+ { "modules": 11, "runtime": "node", "variant": "node", "versions": ">=0.9.9 <0.11" },
+ { "modules": 10, "runtime": "node", "variant": "node", "versions": ">=0.9.1 <0.9.9" },
+ { "modules": 1, "runtime": "node", "variant": "node", "versions": ">=0.2.0 <0.9.8" }
+ ]
+}
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.