Skip to content

Commit de0278a

Browse files
MylesBorinsrvagg
authored andcommitted
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. PR-URL: #22237 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 15098ac commit de0278a

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

BUILDING.md

+11
Original file line numberDiff line numberDiff line change
@@ -502,3 +502,14 @@ To make `./myModule.js` available via `require('myModule')` and
502502
```console
503503
> .\vcbuild link-module './myModule.js' link-module './myModule2.js'
504504
```
505+
506+
## Note for downstream distributors of Node.js
507+
508+
The Node.js ecosystem is reliant on ABI compatibility within a major
509+
release. To maintain ABI compatibility it is required that production
510+
builds of Node.js will be built against the same version of dependencies as the
511+
project vendors. If Node.js is to be built against a different version of a
512+
dependency please create a custom `NODE_MODULE_VERSION` to ensure ecosystem
513+
compatibility. Please consult with the TSC by opening an issue at
514+
https://github.com/nodejs/tsc/issues if you decide to create a custom
515+
`NODE_MODULE_VERSION` so we can avoid duplication in the ecosystem.

0 commit comments

Comments
 (0)