Skip to content

doc: update node-api version matrix #57287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025
Merged

doc: update node-api version matrix #57287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,10 @@ information is in the latest API documentation in:
<th>Node-API version</th>
<th scope="col">Supported In</th>
</tr>
<tr>
<th scope="row">10</th>
<td>v22.14.0+, 23.6.0+ and all later versions</td>
</tr>
<tr>
<th scope="row">9</th>
<td>v18.17.0+, 20.3.0+, 21.0.0 and all later versions</td>
Expand Down
40 changes: 30 additions & 10 deletions doc/contributing/releases-node-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -199,15 +200,30 @@ 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
<tr>
<th scope="row">10</th>
<td>vREPLACEME+ and all later versions</td>
</tr>
```

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:

```text
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.
Expand All @@ -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
Loading