Skip to content

Commit 97b6139

Browse files
committed
doc: add note about ABI compatibility
Building node against versions of the dependencies that differ from the ones we vendor will result in a non ABI compatible version of Node.js This patch adds a note to make it explicit that if individuals build node against different versions of a dependency they should make a custom NODE_MODULE_VERSION.
1 parent f01518e commit 97b6139

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

BUILDING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -528,3 +528,14 @@ To make `./myModule.js` available via `require('myModule')` and
528528
```console
529529
> .\vcbuild link-module './myModule.js' link-module './myModule2.js'
530530
```
531+
532+
## Note for downstream distributors of Node.js
533+
534+
The Node.js ecosystem is reliant on ABI compatibility within a major
535+
release. To maintain ABI compatibility it is required that production
536+
builds of Node.js will be built against the same version of dependencies as the
537+
project vendors. If Node.js is to be built against a different version of a
538+
dependency please create a custom `NODE_MODULE_VERSION` to ensure ecosystem
539+
compatibility. Please consult with the TSC by opening an issue at
540+
https://github.com/nodejs/tsc/issues if you decide to create a custom
541+
`NODE_MODULE_VERSION` so we can avoid duplication in the ecosystem.

0 commit comments

Comments
 (0)