Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update documentation for externalizing deps #54792

Closed
wants to merge 3 commits into from
Closed

doc: update documentation for externalizing deps #54792

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de1e9a7
doc: update documentation for externalizing deps
mhdawson Sep 5, 2024
be0a844
Update doc/contributing/maintaining/maintaining-dependencies.md
mhdawson Sep 5, 2024
0fcf106
Update doc/contributing/maintaining/maintaining-dependencies.md
mhdawson Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/contributing/maintaining/maintaining-dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,17 @@ can be added by:
paste one of the existing entries and then update to match the
import name for the dependency and the #define generated.

* if the version of the dependency is reported in `process.versions`,
update `src/node_metadata.h` and `src/node_metadata.cc` so that the
version is not reported when the dependency is externalized.
Not reporting the version is better than incorrectly reporting
the version of the dependency bundled with Node.js, instead of the
version for the externalized dependency. Use one of the existing
externalized dependencies, like undici, as an example of how to
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
update these files correctly. Make sure to run the tests with the
dependency externalized, as the tests will also need to be updated
to handle this properly.

## Supporting non-externalized dependencies with JavaScript code

If the dependency consists of JavaScript in the
Expand Down
Loading