Skip to content

Commit 7f9eaa0

Browse files
aduh95ionicmc-rs
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: nodejs#51195 Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent d6aa9d6 commit 7f9eaa0

File tree

4 files changed

+73
-101
lines changed

4 files changed

+73
-101
lines changed

doc/contributing/maintaining/maintaining-dependencies.md

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,31 @@ 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.47.0][]
22-
* [llhttp 9.1.3][]
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-
* [simdjson 3.6.2][]
31-
* [simdutf 4.0.4][]
32-
* [undici 5.28.2][]
33-
* [uvwasi 0.0.19][]
34-
* [V8 11.8.172.12][]
35-
* [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+
* [simdjson][]
31+
* [simdutf][]
32+
* [undici][]
33+
* [uvwasi][]
34+
* [V8][]
35+
* [zlib][]
3636

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

146146
## Dependency list
147147

148-
### acorn 8.11.2
148+
### acorn
149149

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

154-
### ada 2.7.4
154+
### ada
155155

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

159-
### base64 0.5.1
159+
### base64
160160

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

166-
### brotli 1.0.9
166+
### brotli
167167

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

171-
### c-ares 1.20.1
171+
### c-ares
172172

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

176-
### cjs-module-lexer 1.2.2
176+
### cjs-module-lexer
177177

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

193-
### googletest 76bb2af
193+
### googletest
194194

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

198-
### histogram 0.11.8
198+
### histogram
199199

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

203-
### icu-small 74.1
203+
### ic
204204

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

210-
### libuv 1.47.0
210+
### libuv
211211

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

216-
### llhttp 9.1.3
216+
### llhttp
217217

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

222-
### minimatch 9.0.3
222+
### minimatch
223223

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

227-
### nghttp2 1.58.0
227+
### nghttp2
228228

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

233-
### nghttp3 0.7.0
233+
### nghttp3
234234

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

238-
### ngtcp2 0.8.1
238+
### ngtcp2
239239

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

258-
### npm 9.6.7
258+
### npm
259259

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

273-
### openssl 3.0.8
273+
### openssl
274274

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

285-
### postject 1.0.0-alpha.6
285+
### postject
286286

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

290-
### simdjson 3.6.2
290+
### simdjson
291291

292292
The [simdjson](https://github.com/simdjson/simdjson) dependency is
293293
a C++ library for fast JSON parsing.
294294

295-
### simdutf 4.0.4
295+
### simdutf
296296

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

300-
### undici 5.28.2
300+
### undici
301301

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

306-
### uvwasi 0.0.19
306+
### uvwasi
307307

308308
The [uvwasi](https://github.com/nodejs/uvwasi) dependency implements
309309
the WASI system call API, so that WebAssembly runtimes can easily
310310
implement WASI calls.
311311
Under the hood, uvwasi leverages libuv where possible for maximum portability.
312312
See [maintaining-web-assembly][] for more informations.
313313

314-
### V8 11.8.172.12
314+
### V8
315315

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

320-
### zlib 1.3.0.1-motley-dd5fc13
320+
### zlib
321321

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

327-
[acorn 8.11.2]: #acorn-8112
328-
[ada 2.7.4]: #ada-274
329-
[base64 0.5.1]: #base64-051
330-
[brotli 1.0.9]: #brotli-109
331-
[c-ares 1.20.1]: #c-ares-1201
332-
[cjs-module-lexer 1.2.2]: #cjs-module-lexer-122
327+
[acorn]: #acorn
328+
[ada]: #ada
329+
[base64]: #base64
330+
[brotli]: #brotli
331+
[c-ares]: #c-ares
332+
[cjs-module-lexer]: #cjs-module-lexer
333333
[corepack]: #corepack
334334
[dependency-update-action]: ../../../.github/workflows/tools.yml
335-
[googletest 76bb2af]: #googletest-76bb2af
336-
[histogram 0.11.8]: #histogram-0118
337-
[icu-small 74.1]: #icu-small-741
338-
[libuv 1.47.0]: #libuv-1470
339-
[llhttp 9.1.3]: #llhttp-913
335+
[googletest]: #googletest
336+
[histogram]: #histogram
337+
[icu-small]: #icu-small
338+
[libuv]: #libuv
339+
[llhttp]: #llhttp
340340
[maintaining-V8]: ./maintaining-V8.md
341341
[maintaining-cjs-module-lexer]: ./maintaining-cjs-module-lexer.md
342342
[maintaining-http]: ./maintaining-http.md
343343
[maintaining-icu]: ./maintaining-icu.md
344344
[maintaining-openssl]: ./maintaining-openssl.md
345345
[maintaining-web-assembly]: ./maintaining-web-assembly.md
346-
[minimatch 9.0.3]: #minimatch-903
347-
[nghttp2 1.58.0]: #nghttp2-1580
348-
[nghttp3 0.7.0]: #nghttp3-070
349-
[ngtcp2 0.8.1]: #ngtcp2-081
350-
[npm 9.6.7]: #npm-967
351-
[openssl 3.0.8]: #openssl-308
352-
[postject 1.0.0-alpha.6]: #postject-100-alpha6
353-
[simdjson 3.6.2]: #simdjson-362
354-
[simdutf 4.0.4]: #simdutf-404
355-
[undici 5.28.2]: #undici-5282
346+
[minimatch]: #minimatch
347+
[nghttp2]: #nghttp2
348+
[nghttp3]: #nghttp3
349+
[ngtcp2]: #ngtcp2
350+
[npm]: #npm
351+
[openssl]: #openssl
352+
[postject]: #postject
353+
[simdjson]: #simdjson
354+
[simdutf]: #simdutf
355+
[undici]: #undici
356356
[update-openssl-action]: ../../../.github/workflows/update-openssl.yml
357-
[uvwasi 0.0.19]: #uvwasi-0019
358-
[v8 11.8.172.12]: #v8-11817212
359-
[zlib 1.3.0.1-motley-dd5fc13]: #zlib-1301-motley-dd5fc13
357+
[uvwasi]: #uvwasi
358+
[v8]: #v8
359+
[zlib]: #zlib

tools/dep_updaters/update-openssl.sh

Lines changed: 0 additions & 3 deletions
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

Lines changed: 0 additions & 5 deletions
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

Lines changed: 1 addition & 21 deletions
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)