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 c1d73ab

Browse filesBrowse files
mhdawsontargos
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 eca9668 commit c1d73ab
Copy full SHA for c1d73ab

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
@@ -126,6 +126,17 @@ can be added by:
126126
paste one of the existing entries and then update to match the
127127
import name for the dependency and the #define generated.
128128

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

131142
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.