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 3fe8eac

Browse filesBrowse files
legendecasaduh95
legendecas
authored and
aduh95
committed
doc: update node-api version matrix
PR-URL: #57287 Fixes: #57284 Refs: #55676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Vladimir Morozov <vmorozov@microsoft.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Michael Dawson <midawson@redhat.com>
1 parent 15d7908 commit 3fe8eac
Copy full SHA for 3fe8eac

File tree

Expand file treeCollapse file tree

2 files changed

+34
-10
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

2 files changed

+34
-10
lines changed
Open diff view settings
Collapse file

‎doc/api/n-api.md‎

Copy file name to clipboardExpand all lines: doc/api/n-api.md
+4Lines changed: 4 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,10 @@ information is in the latest API documentation in:
291291
<th>Node-API version</th>
292292
<th scope="col">Supported In</th>
293293
</tr>
294+
<tr>
295+
<th scope="row">10</th>
296+
<td>v22.14.0+, 23.6.0+ and all later versions</td>
297+
</tr>
294298
<tr>
295299
<th scope="row">9</th>
296300
<td>v18.17.0+, 20.3.0+, 21.0.0 and all later versions</td>
Collapse file

‎doc/contributing/releases-node-api.md‎

Copy file name to clipboardExpand all lines: doc/contributing/releases-node-api.md
+30-10Lines changed: 30 additions & 10 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ release process.
1212
* [3. Update `NODE_API_SUPPORTED_VERSION_MAX`](#3-update-node_api_supported_version_max)
1313
* [4. Define `addon_context_register_func`](#4-define-addon_context_register_func)
1414
* [5. Update version guards](#5-update-version-guards)
15-
* [6. Create release commit](#6-create-release-commit)
16-
* [7. Propose release on GitHub](#7-propose-release-on-github)
17-
* [8. Ensure that the release branch is stable](#8-ensure-that-the-release-branch-is-stable)
18-
* [9. Land the release](#9-land-the-release)
19-
* [10. Backport the release](#10-backport-the-release)
15+
* [6. Update version matrix document](#6-update-version-matrix-document)
16+
* [7. Create release commit](#7-create-release-commit)
17+
* [8. Propose release on GitHub](#8-propose-release-on-github)
18+
* [9. Ensure that the release branch is stable](#9-ensure-that-the-release-branch-is-stable)
19+
* [10. Land the release](#10-land-the-release)
20+
* [11. Backport the release](#11-backport-the-release)
2021

2122
## How to create a release
2223

@@ -199,15 +200,30 @@ released version `x`:
199200
+ * version 10:
200201
```
201202

202-
### 6. Create release commit
203+
### 6. Update version matrix document
204+
205+
Add a new row in the [version matrix][] for
206+
the new version:
207+
208+
```text
209+
<tr>
210+
<th scope="row">10</th>
211+
<td>vREPLACEME+ and all later versions</td>
212+
</tr>
213+
```
214+
215+
In this case, use `REPLACEME` as a placeholder for the Node.js version to be released.
216+
It will be updated in a Node.js version release.
217+
218+
### 7. Create release commit
203219

204220
When committing these to git, use the following message format:
205221

206222
```text
207223
node-api: define version x
208224
```
209225

210-
### 7. Propose release on GitHub
226+
### 8. Propose release on GitHub
211227

212228
Create a pull request targeting the `main` branch. These PRs should be left
213229
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.
218234
Tag the PR with the `notable-change` label, and @-mention the GitHub team
219235
@nodejs/node-api and @nodejs/node-api-implementer.
220236

221-
### 8. Ensure that the release branch is stable
237+
### 9. Ensure that the release branch is stable
222238

223239
Run a **[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)**
224240
test run to ensure that the build is stable and the HEAD commit is ready for
225241
release.
226242

227-
### 9. Land the release
243+
### 10. Land the release
228244

229245
See the steps documented in [Collaborator Guide - Landing a PR][] to land the
230246
PR.
231247

232-
### 10. Backport the release
248+
### 11. Backport the release
233249

234250
Consider backporting the release to all LTS versions following the steps
235251
documented in the [backporting guide][].
236252

253+
Additionally, update the [version matrix][] for the backported version if
254+
necessary.
255+
237256
[Collaborator Guide - Landing a PR]: ./collaborator-guide.md#landing-pull-requests
238257
[abi-stable-node issue tracker]: https://github.com/nodejs/abi-stable-node/issues
239258
[backporting guide]: backporting-to-release-lines.md
259+
[version matrix]: ../api/n-api.md#node-api-version-matrix

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.