From 64f6a2fc4dc8c8556a3d61c77d4110b259ffe3a4 Mon Sep 17 00:00:00 2001 From: Chengzhong Wu Date: Wed, 5 Mar 2025 10:10:10 +0000 Subject: [PATCH] doc: update node-api version matrix PR-URL: https://github.com/nodejs/node/pull/57287 Fixes: https://github.com/nodejs/node/issues/57284 Refs: https://github.com/nodejs/node/pull/55676 Reviewed-By: Luigi Pinca Reviewed-By: Marco Ippolito Reviewed-By: Vladimir Morozov Reviewed-By: Richard Lau Reviewed-By: Rafael Gonzaga Reviewed-By: Ben Noordhuis Reviewed-By: Michael Dawson --- doc/api/n-api.md | 4 +++ doc/contributing/releases-node-api.md | 40 ++++++++++++++++++++------- 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 3ba991dc117..02bedabceb5 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -291,6 +291,10 @@ information is in the latest API documentation in: Node-API version Supported In + + 10 + v22.14.0+, 23.6.0+ and all later versions + 9 v18.17.0+, 20.3.0+, 21.0.0 and all later versions diff --git a/doc/contributing/releases-node-api.md b/doc/contributing/releases-node-api.md index f8bcd273e39..6d1f52902f6 100644 --- a/doc/contributing/releases-node-api.md +++ b/doc/contributing/releases-node-api.md @@ -12,11 +12,12 @@ release process. * [3. Update `NODE_API_SUPPORTED_VERSION_MAX`](#3-update-node_api_supported_version_max) * [4. Define `addon_context_register_func`](#4-define-addon_context_register_func) * [5. Update version guards](#5-update-version-guards) - * [6. Create release commit](#6-create-release-commit) - * [7. Propose release on GitHub](#7-propose-release-on-github) - * [8. Ensure that the release branch is stable](#8-ensure-that-the-release-branch-is-stable) - * [9. Land the release](#9-land-the-release) - * [10. Backport the release](#10-backport-the-release) + * [6. Update version matrix document](#6-update-version-matrix-document) + * [7. Create release commit](#7-create-release-commit) + * [8. Propose release on GitHub](#8-propose-release-on-github) + * [9. Ensure that the release branch is stable](#9-ensure-that-the-release-branch-is-stable) + * [10. Land the release](#10-land-the-release) + * [11. Backport the release](#11-backport-the-release) ## How to create a release @@ -199,7 +200,22 @@ released version `x`: + * version 10: ``` -### 6. Create release commit +### 6. Update version matrix document + +Add a new row in the [version matrix][] for +the new version: + +```text + + 10 + vREPLACEME+ and all later versions + +``` + +In this case, use `REPLACEME` as a placeholder for the Node.js version to be released. +It will be updated in a Node.js version release. + +### 7. Create release commit When committing these to git, use the following message format: @@ -207,7 +223,7 @@ When committing these to git, use the following message format: node-api: define version x ``` -### 7. Propose release on GitHub +### 8. Propose release on GitHub Create a pull request targeting the `main` branch. These PRs should be left open for at least 24 hours, and can be updated as new commits land. @@ -218,22 +234,26 @@ good place to @-mention the relevant contributors. Tag the PR with the `notable-change` label, and @-mention the GitHub team @nodejs/node-api and @nodejs/node-api-implementer. -### 8. Ensure that the release branch is stable +### 9. Ensure that the release branch is stable Run a **[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)** test run to ensure that the build is stable and the HEAD commit is ready for release. -### 9. Land the release +### 10. Land the release See the steps documented in [Collaborator Guide - Landing a PR][] to land the PR. -### 10. Backport the release +### 11. Backport the release Consider backporting the release to all LTS versions following the steps documented in the [backporting guide][]. +Additionally, update the [version matrix][] for the backported version if +necessary. + [Collaborator Guide - Landing a PR]: ./collaborator-guide.md#landing-pull-requests [abi-stable-node issue tracker]: https://github.com/nodejs/abi-stable-node/issues [backporting guide]: backporting-to-release-lines.md +[version matrix]: ../api/n-api.md#node-api-version-matrix