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.

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

doc: update documentation for externalizing deps #54792

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Update doc/contributing/maintaining/maintaining-dependencies.md
Co-authored-by: Aviv Keller <telavivkeller@gmail.com>
  • Loading branch information
mhdawson and avivkeller authored Sep 5, 2024
commit be0a84464c17ad0af491fbb1bbf069837b2f701b
16 changes: 8 additions & 8 deletions doc/contributing/maintaining/maintaining-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,16 @@ 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
* 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 depenency. Use one of the existing
externalized dependencies like undici as an example of how to
do that. Make sure to run the tests with the dependency externalized
as the tests will also need to be updated to handle this properly.
For example, test/parallel/test-process-versions.js.
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

Expand Down
Loading