Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit a4586f0

Browse filesBrowse files
mhdawsonmarco-ippolito
authored andcommitted
doc: update documentation for externalizing deps
Refs: #54646 - Add instructions to update how process.versions is reported as I missed that in a recent addition. Signed-off-by: Michael Dawson <midawson@redhat.com> PR-URL: #54792 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
1 parent 70504f8 commit a4586f0
Copy full SHA for a4586f0

File tree

Expand file treeCollapse file tree

1 file changed

+11
-0
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+11
-0
lines changed
Open diff view settings
Collapse file

‎doc/contributing/maintaining/maintaining-dependencies.md‎

Copy file name to clipboardExpand all lines: doc/contributing/maintaining/maintaining-dependencies.md
+11Lines changed: 11 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,17 @@ can be added by:
123123
paste one of the existing entries and then update to match the
124124
import name for the dependency and the #define generated.
125125

126+
* if the version of the dependency is reported in `process.versions`,
127+
update `src/node_metadata.h` and `src/node_metadata.cc` so that the
128+
version is not reported when the dependency is externalized.
129+
Not reporting the version is better than incorrectly reporting
130+
the version of the dependency bundled with Node.js, instead of the
131+
version for the externalized dependency. Use one of the existing
132+
externalized dependencies, like Undici, as an example of how to
133+
update these files correctly. Make sure to run the tests with the
134+
dependency externalized, as the tests will also need to be updated
135+
to handle this properly.
136+
126137
## Supporting non-externalized dependencies with JavaScript code
127138

128139
If the dependency consists of JavaScript in the

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.