Skip to content

Commit eaadebb

Browse files
aduh95richardlau
authored andcommitted
doc: remove version from maintaining-dependencies.md
Those create unreasonable maintenance burden as updating one dependency will conflict with another one. It's unclear we get much value out from duplicating this information in this document, so this commit removes it PR-URL: #51195 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]>
1 parent 9062d30 commit eaadebb

File tree

4 files changed

+70
-98
lines changed

4 files changed

+70
-98
lines changed

doc/contributing/maintaining/maintaining-dependencies.md

+69-69
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,30 @@ directories to create the Node.js binaries.
88
All dependencies are located within the `deps` directory.
99
This a list of all the dependencies:
1010

11-
* [acorn 8.11.2][]
12-
* [ada 2.7.4][]
13-
* [base64 0.5.1][]
14-
* [brotli 1.0.9][]
15-
* [c-ares 1.20.1][]
16-
* [cjs-module-lexer 1.2.2][]
11+
* [acorn][]
12+
* [ada][]
13+
* [base64][]
14+
* [brotli][]
15+
* [c-ares][]
16+
* [cjs-module-lexer][]
1717
* [corepack][]
18-
* [googletest 76bb2af][]
19-
* [histogram 0.11.8][]
20-
* [icu-small 74.1][]
21-
* [libuv 1.46.0][]
22-
* [llhttp 8.1.0][]
23-
* [minimatch 9.0.3][]
24-
* [nghttp2 1.58.0][]
25-
* [nghttp3 0.7.0][]
26-
* [ngtcp2 0.8.1][]
27-
* [npm 9.6.7][]
28-
* [openssl 3.0.8][]
29-
* [postject 1.0.0-alpha.6][]
30-
* [simdutf 4.0.4][]
31-
* [undici 5.27.2][]
32-
* [uvwasi 0.0.19][]
33-
* [V8 11.3.244.8][]
34-
* [zlib 1.3.0.1-motley-dd5fc13][]
18+
* [googletest][]
19+
* [histogram][]
20+
* [icu-small][]
21+
* [libuv][]
22+
* [llhttp][]
23+
* [minimatch][]
24+
* [nghttp2][]
25+
* [nghttp3][]
26+
* [ngtcp2][]
27+
* [npm][]
28+
* [openssl][]
29+
* [postject][]
30+
* [simdutf][]
31+
* [undici][]
32+
* [uvwasi][]
33+
* [V8][]
34+
* [zlib][]
3535

3636
Any code which meets one or more of these conditions should
3737
be managed as a dependency:
@@ -144,35 +144,35 @@ takes care of npm update, it is maintained by the npm team.
144144

145145
## Dependency list
146146

147-
### acorn 8.11.2
147+
### acorn
148148

149149
The [acorn](https://github.com/acornjs/acorn) dependency is a JavaScript parser.
150150
[acorn-walk](https://github.com/acornjs/acorn/tree/master/acorn-walk) is
151151
an abstract syntax tree walker for the ESTree format.
152152

153-
### ada 2.7.4
153+
### ada
154154

155155
The [ada](https://github.com/ada-url/ada) dependency is a
156156
fast and spec-compliant URL parser written in C++.
157157

158-
### base64 0.5.1
158+
### base64
159159

160160
The [base64](https://github.com/aklomp/base64) dependency is a base64
161161
stream encoding/decoding library in C99 with SIMD and OpenMP acceleration.
162162
It also contains wrapper functions to encode/decode simple
163163
length-delimited strings.
164164

165-
### brotli 1.0.9
165+
### brotli
166166

167167
The [brotli](https://github.com/google/brotli) dependency is
168168
used for the homonym generic-purpose lossless compression algorithm.
169169

170-
### c-ares 1.20.1
170+
### c-ares
171171

172172
The [c-ares](https://github.com/c-ares/c-ares) is a C library
173173
for asynchronous DNS requests.
174174

175-
### cjs-module-lexer 1.2.2
175+
### cjs-module-lexer
176176

177177
The [cjs-module-lexer](https://github.com/nodejs/node/tree/HEAD/deps/cjs-module-lexer)
178178
dependency is used within the Node.js ESM implementation to detect the
@@ -189,52 +189,52 @@ In practical terms, Corepack will let you use Yarn and pnpm without having to
189189
install them - just like what currently happens with npm, which is shipped
190190
by Node.js by default.
191191

192-
### googletest 76bb2af
192+
### googletest
193193

194194
The [googletest](https://github.com/google/googletest) dependency is Google’s
195195
C++ testing and mocking framework.
196196

197-
### histogram 0.11.8
197+
### histogram
198198

199199
The [histogram](https://github.com/HdrHistogram/HdrHistogram_c) dependency is
200200
a C port of High Dynamic Range (HDR) Histogram.
201201

202-
### icu-small 74.1
202+
### ic
203203

204204
The [icu](http://site.icu-project.org) is widely used set of C/C++
205205
and Java libraries providing Unicode and Globalization
206206
support for software applications.
207207
See [maintaining-icu][] for more informations.
208208

209-
### libuv 1.46.0
209+
### libuv
210210

211211
The [libuv](https://github.com/libuv/libuv) dependency is a
212212
multi-platform support library with a focus on asynchronous I/O.
213213
It was primarily developed for use by Node.js.
214214

215-
### llhttp 8.1.0
215+
### llhttp
216216

217217
The [llhttp](https://github.com/nodejs/llhttp) dependency is
218218
the http parser used by Node.js.
219219
See [maintaining-http][] for more informations.
220220

221-
### minimatch 9.0.3
221+
### minimatch
222222

223223
The [minimatch](https://github.com/isaacs/minimatch) dependency is a
224224
minimal matching utility.
225225

226-
### nghttp2 1.58.0
226+
### nghttp2
227227

228228
The [nghttp2](https://github.com/nghttp2/nghttp2) dependency is a C library
229229
implementing HTTP/2 protocol.
230230
See [maintaining-http][] for more informations.
231231

232-
### nghttp3 0.7.0
232+
### nghttp3
233233

234234
The [nghttp3](https://github.com/ngtcp2/nghttp3) dependency is HTTP/3 library
235235
written in C. See ngtcp2 for more informations.
236236

237-
### ngtcp2 0.8.1
237+
### ngtcp2
238238

239239
The ngtcp2 and nghttp3 dependencies provide the core functionality for
240240
QUIC and HTTP/3.
@@ -254,7 +254,7 @@ The `nghttp3` library depends on `ngtcp2`. Both should always be updated
254254
together. From `ngtcp2` we only want the contents of the `lib` and `crypto`
255255
directories; from `nghttp3` we only want the contents of the `lib` directory.
256256

257-
### npm 9.6.7
257+
### npm
258258

259259
The [npm](https://github.com/npm/cli) dependency is
260260
the package manager for JavaScript.
@@ -269,7 +269,7 @@ are at the discretion of the release and LTS teams.
269269
This process only covers full updates to new versions of npm. Cherry-picked
270270
changes can be reviewed and landed via the normal consensus seeking process.
271271

272-
### openssl 3.0.8
272+
### openssl
273273

274274
The [openssl](https://github.com/quictls/openssl) dependency is a
275275
fork of OpenSSL to enable QUIC.
@@ -281,72 +281,72 @@ the main openssl/openssl releases with the addition of APIs to support
281281
the QUIC protocol.
282282
See [maintaining-openssl][] for more informations.
283283

284-
### postject 1.0.0-alpha.6
284+
### postject
285285

286286
The [postject](https://github.com/nodejs/postject) dependency is used for the
287287
[Single Executable strategic initiative](https://github.com/nodejs/single-executable).
288288

289-
### simdutf 4.0.4
289+
### simdutf
290290

291291
The [simdutf](https://github.com/simdutf/simdutf) dependency is
292292
a C++ library for fast UTF-8 decoding and encoding.
293293

294-
### undici 5.27.2
294+
### undici
295295

296296
The [undici](https://github.com/nodejs/undici) dependency is an HTTP/1.1 client,
297297
written from scratch for Node.js..
298298
See [maintaining-http][] for more informations.
299299

300-
### uvwasi 0.0.19
300+
### uvwasi
301301

302302
The [uvwasi](https://github.com/nodejs/uvwasi) dependency implements
303303
the WASI system call API, so that WebAssembly runtimes can easily
304304
implement WASI calls.
305305
Under the hood, uvwasi leverages libuv where possible for maximum portability.
306306
See [maintaining-web-assembly][] for more informations.
307307

308-
### V8 11.3.244.8
308+
### V8
309309

310310
[V8](https://chromium.googlesource.com/v8/v8.git/) is Google's open source
311311
high-performance JavaScript and WebAssembly engine, written in C++.
312312
See [maintaining-V8][] for more informations.
313313

314-
### zlib 1.3.0.1-motley-dd5fc13
314+
### zlib
315315

316316
The [zlib](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/third_party/zlib)
317317
dependency lossless data-compression library,
318318
it comes from the Chromium team's zlib fork which incorporated
319319
performance improvements not currently available in standard zlib.
320320

321-
[acorn 8.11.2]: #acorn-8112
322-
[ada 2.7.4]: #ada-274
323-
[base64 0.5.1]: #base64-051
324-
[brotli 1.0.9]: #brotli-109
325-
[c-ares 1.20.1]: #c-ares-1201
326-
[cjs-module-lexer 1.2.2]: #cjs-module-lexer-122
321+
[acorn]: #acorn
322+
[ada]: #ada
323+
[base64]: #base64
324+
[brotli]: #brotli
325+
[c-ares]: #c-ares
326+
[cjs-module-lexer]: #cjs-module-lexer
327327
[corepack]: #corepack
328328
[dependency-update-action]: ../../../.github/workflows/tools.yml
329-
[googletest 76bb2af]: #googletest-76bb2af
330-
[histogram 0.11.8]: #histogram-0118
331-
[icu-small 74.1]: #icu-small-741
332-
[libuv 1.46.0]: #libuv-1460
333-
[llhttp 8.1.0]: #llhttp-810
329+
[googletest]: #googletest
330+
[histogram]: #histogram
331+
[icu-small]: #icu-small
332+
[libuv]: #libuv
333+
[llhttp]: #llhttp
334334
[maintaining-V8]: ./maintaining-V8.md
335335
[maintaining-cjs-module-lexer]: ./maintaining-cjs-module-lexer.md
336336
[maintaining-http]: ./maintaining-http.md
337337
[maintaining-icu]: ./maintaining-icu.md
338338
[maintaining-openssl]: ./maintaining-openssl.md
339339
[maintaining-web-assembly]: ./maintaining-web-assembly.md
340-
[minimatch 9.0.3]: #minimatch-903
341-
[nghttp2 1.58.0]: #nghttp2-1580
342-
[nghttp3 0.7.0]: #nghttp3-070
343-
[ngtcp2 0.8.1]: #ngtcp2-081
344-
[npm 9.6.7]: #npm-967
345-
[openssl 3.0.8]: #openssl-308
346-
[postject 1.0.0-alpha.6]: #postject-100-alpha6
347-
[simdutf 4.0.4]: #simdutf-404
348-
[undici 5.27.2]: #undici-5272
340+
[minimatch]: #minimatch
341+
[nghttp2]: #nghttp2
342+
[nghttp3]: #nghttp3
343+
[ngtcp2]: #ngtcp2
344+
[npm]: #npm
345+
[openssl]: #openssl
346+
[postject]: #postject
347+
[simdutf]: #simdutf
348+
[undici]: #undici
349349
[update-openssl-action]: ../../../.github/workflows/update-openssl.yml
350-
[uvwasi 0.0.19]: #uvwasi-0019
351-
[v8 11.3.244.8]: #v8-1132448
352-
[zlib 1.3.0.1-motley-dd5fc13]: #zlib-1301-motley-dd5fc13
350+
[uvwasi]: #uvwasi
351+
[v8]: #v8
352+
[zlib]: #zlib

tools/dep_updaters/update-openssl.sh

-3
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,11 @@ EOF
105105
rm -rf "$DEPS_DIR/openssl/openssl"
106106
mv "$WORKSPACE/openssl" "$DEPS_DIR/openssl/"
107107

108-
# Update the version number
109-
update_dependency_version "openssl" "$NEW_VERSION_V3"
110108
echo "All done!"
111109
echo ""
112110
echo "Please git add openssl, and commit the new version:"
113111
echo ""
114112
echo "$ git add -A deps/openssl/openssl"
115-
echo "$ git add doc/contributing/maintaining/maintaining-dependencies.md"
116113
echo "$ git commit -m \"deps: upgrade openssl sources to quictls/openssl-$NEW_VERSION_V3\""
117114
echo ""
118115
# The last line of the script should always print the new version,

tools/dep_updaters/update-v8-patch.sh

-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,6 @@ CURRENT_PATCH_VERSION=$(grep "#define V8_PATCH_LEVEL" "$DEPS_DIR/v8/include/v8-v
2626
NEW_VERSION="$CURRENT_MAJOR_VERSION.$CURRENT_MINOR_VERSION.$CURRENT_BUILD_VERSION.$CURRENT_PATCH_VERSION"
2727

2828

29-
# Update the version number. We have to call it twice because V8 is written
30-
# both in lowercase and uppdercase
31-
update_dependency_version "v8" "$NEW_VERSION"
32-
update_dependency_version "V8" "$NEW_VERSION"
33-
3429
echo "All done!"
3530
echo ""
3631

tools/dep_updaters/utils.sh

+1-21
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#!/bin/sh
22

33
ROOT=$(cd "$(dirname "$0")/../.." && pwd)
4+
export ROOT
45

56
# This function compare new version with current version of a depdendency and
67
# exit the script if the versions are the same
@@ -34,15 +35,11 @@ finalize_version_update() {
3435
new_version="$2"
3536
extra_files="$3"
3637

37-
# Update the version number on maintaining-dependencies.md
38-
update_dependency_version "$package_name" "$new_version"
39-
4038
echo "All done!"
4139
echo ""
4240
echo "Please git add $package_name and commit the new version:"
4341
echo ""
4442
echo "$ git add -A deps/$package_name $extra_files"
45-
echo "$ git add doc/contributing/maintaining/maintaining-dependencies.md"
4643
echo "$ git commit -m \"deps: update $package_name to $new_version\""
4744
echo ""
4845

@@ -80,20 +77,3 @@ log_and_verify_sha256sum() {
8077
fi
8178
fi
8279
}
83-
84-
# This function update the version of a maintained dependency in
85-
# https://github.com/nodejs/node/blob/main/doc/contributing/maintaining/maintaining-dependencies.md
86-
#
87-
# $1 is the package name e.g. 'acorn', 'ada', 'base64' etc. See that file
88-
# for a complete list of package name
89-
# $2 is the new version.
90-
update_dependency_version() {
91-
package_name="$1"
92-
new_version="$2"
93-
deps_file_path="$ROOT/doc/contributing/maintaining/maintaining-dependencies.md"
94-
# Remove version dots for anchor markdown
95-
version_no_dots=$(echo "$new_version" | sed -e 's/\.//g')
96-
perl -i -pe 's|^\* \['"$package_name"'.*|* ['"$package_name"' '"$new_version"'][]|' "$deps_file_path"
97-
perl -i -pe 's|^\['"$package_name"'.*\]: #'"$package_name"'.*|['"$package_name"' '"$new_version"']: #'"$package_name"'-'"$version_no_dots"'|' "$deps_file_path"
98-
perl -i -pe 's|^### '"$package_name"'.*|### '"$package_name"' '"$new_version"'|' "$deps_file_path"
99-
}

0 commit comments

Comments
 (0)