From 2f176e7f577447019cf3f0b88ad0376269d8bd69 Mon Sep 17 00:00:00 2001 From: Andrea Fassina Date: Wed, 31 May 2023 18:23:49 +0200 Subject: [PATCH 1/2] docs: update maintaining-dependencies.md on major update --- lib/update-v8/updateVersionNumbers.js | 30 ++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/lib/update-v8/updateVersionNumbers.js b/lib/update-v8/updateVersionNumbers.js index abbe6b45..8813b392 100644 --- a/lib/update-v8/updateVersionNumbers.js +++ b/lib/update-v8/updateVersionNumbers.js @@ -29,10 +29,15 @@ function bumpNodeModule() { v8Version, ctx.nodeMajorVersion ); + await updateMaintainingDependenciesMd(ctx.nodeDir, v8Version); await updateModuleVersion(ctx.nodeDir, newModuleVersion); await ctx.execGitNode( 'add', - ['doc/abi_version_registry.json', 'src/node_version.h'] + [ + 'doc/abi_version_registry.json', + 'doc/contributing/maintaining/maintaining-dependencies.md', + 'src/node_version.h' + ] ); await ctx.execGitNode( 'commit', @@ -80,6 +85,29 @@ async function updateModuleVersion(nodeDir, newVersion) { await fs.writeFile(path, nodeVersionH); } +async function updateMaintainingDependenciesMd(nodeDir, v8Version) { + const path = `${nodeDir}/doc/contributing/maintaining/maintaining-dependencies.md`; + let maintainingDependenciesMd = await fs.readFile(path, 'utf8'); + const version = v8Version.toString(); + const versionNoDots = version.replaceAll('.', ''); + // V8 itemlist link + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /\* \[V8.*/, + `* [V8 ${version}][]` + ); + // V8 link to section + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /\[v8.*\]: #v8.*/, + `[v8 ${version}]: #v8-${versionNoDots}` + ); + // V8 section title + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /### V8.*/, + `### V8 ${version}` + ); + await fs.writeFile(path, maintainingDependenciesMd); +} + function getCommitTitle(moduleVersion) { return `src: update NODE_MODULE_VERSION to ${moduleVersion}`; } From d4e53e592b73ca551e40b0d9e5a4d779f461cdcf Mon Sep 17 00:00:00 2001 From: Andrea Fassina Date: Thu, 1 Jun 2023 09:21:16 +0200 Subject: [PATCH 2/2] docs: move maintaining dependencies task --- lib/update-v8/index.js | 9 ++++- .../updateMaintainingDependencies.js | 34 +++++++++++++++++++ lib/update-v8/updateVersionNumbers.js | 30 +--------------- 3 files changed, 43 insertions(+), 30 deletions(-) create mode 100644 lib/update-v8/updateMaintainingDependencies.js diff --git a/lib/update-v8/index.js b/lib/update-v8/index.js index 0fa6c536..a8583691 100644 --- a/lib/update-v8/index.js +++ b/lib/update-v8/index.js @@ -6,11 +6,18 @@ import updateVersionNumbers from './updateVersionNumbers.js'; import commitUpdate from './commitUpdate.js'; import majorUpdate from './majorUpdate.js'; import minorUpdate from './minorUpdate.js'; +import updateMaintainingDependencies from './updateMaintainingDependencies.js'; import updateV8Clone from './updateV8Clone.js'; export function major(options) { const tasks = new Listr( - [updateV8Clone(), majorUpdate(), commitUpdate(), updateVersionNumbers()], + [ + updateV8Clone(), + majorUpdate(), + updateMaintainingDependencies(), + commitUpdate(), + updateVersionNumbers() + ], getOptions(options) ); return tasks.run(options); diff --git a/lib/update-v8/updateMaintainingDependencies.js b/lib/update-v8/updateMaintainingDependencies.js new file mode 100644 index 00000000..1090f4ae --- /dev/null +++ b/lib/update-v8/updateMaintainingDependencies.js @@ -0,0 +1,34 @@ +import { promises as fs } from 'node:fs'; +import { getNodeV8Version } from './util.js'; + +export default function updateMaintainingDependencies() { + return { + title: 'Update V8 version in maintaining-dependencies.md', + task: async(ctx) => { + const path = `${ctx.nodeDir}/doc/contributing/maintaining/maintaining-dependencies.md`; + let maintainingDependenciesMd = await fs.readFile(path, 'utf8'); + const v8Version = (await getNodeV8Version(ctx.nodeDir)).toString(); + const v8VersionNoDots = v8Version.replaceAll('.', ''); + // V8 itemlist link + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /\* \[V8.*/, + `* [V8 ${v8Version}][]` + ); + // V8 link to section + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /\[v8.*\]: #v8.*/, + `[v8 ${v8Version}]: #v8-${v8VersionNoDots}` + ); + // V8 section title + maintainingDependenciesMd = maintainingDependenciesMd.replace( + /### V8.*/, + `### V8 ${v8Version}` + ); + await fs.writeFile(path, maintainingDependenciesMd); + await ctx.execGitNode( + 'add', + ['doc/contributing/maintaining/maintaining-dependencies.md'] + ); + } + }; +}; diff --git a/lib/update-v8/updateVersionNumbers.js b/lib/update-v8/updateVersionNumbers.js index 8813b392..abbe6b45 100644 --- a/lib/update-v8/updateVersionNumbers.js +++ b/lib/update-v8/updateVersionNumbers.js @@ -29,15 +29,10 @@ function bumpNodeModule() { v8Version, ctx.nodeMajorVersion ); - await updateMaintainingDependenciesMd(ctx.nodeDir, v8Version); await updateModuleVersion(ctx.nodeDir, newModuleVersion); await ctx.execGitNode( 'add', - [ - 'doc/abi_version_registry.json', - 'doc/contributing/maintaining/maintaining-dependencies.md', - 'src/node_version.h' - ] + ['doc/abi_version_registry.json', 'src/node_version.h'] ); await ctx.execGitNode( 'commit', @@ -85,29 +80,6 @@ async function updateModuleVersion(nodeDir, newVersion) { await fs.writeFile(path, nodeVersionH); } -async function updateMaintainingDependenciesMd(nodeDir, v8Version) { - const path = `${nodeDir}/doc/contributing/maintaining/maintaining-dependencies.md`; - let maintainingDependenciesMd = await fs.readFile(path, 'utf8'); - const version = v8Version.toString(); - const versionNoDots = version.replaceAll('.', ''); - // V8 itemlist link - maintainingDependenciesMd = maintainingDependenciesMd.replace( - /\* \[V8.*/, - `* [V8 ${version}][]` - ); - // V8 link to section - maintainingDependenciesMd = maintainingDependenciesMd.replace( - /\[v8.*\]: #v8.*/, - `[v8 ${version}]: #v8-${versionNoDots}` - ); - // V8 section title - maintainingDependenciesMd = maintainingDependenciesMd.replace( - /### V8.*/, - `### V8 ${version}` - ); - await fs.writeFile(path, maintainingDependenciesMd); -} - function getCommitTitle(moduleVersion) { return `src: update NODE_MODULE_VERSION to ${moduleVersion}`; }