Skip to content

Commit 5137bc6

Browse files
committed
fixup! doc: update V8 ABI release policy
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
1 parent d59f6b0 commit 5137bc6

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

‎doc/contributing/releases.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,16 +1384,17 @@ a `NODE_MODULE_VERSION` bump, such as V8 updates, may land during the Alpha and
13841384
Current phases of a release line. Such changes should still be labeled as
13851385
semver-major on the default branch. When they are promoted to the release line,
13861386
they may land in semver-minor releases as long as the ABI change is clearly
1387-
documented in the release notes. If the change also removes or modifies APIs
1388-
that addons use, so that addons need source changes rather than only a
1389-
rebuild, the release notes should say so.
1387+
documented in the release notes.
13901388

13911389
Once a release line enters LTS, ABI-breaking changes are strongly discouraged.
13921390
They should only land when they are necessary, such as for security fixes, and
1393-
when there is no way to make the change without breaking the ABI. Changes that
1394-
are not necessary for an LTS line, such as adding fields to a struct to expose
1395-
more information in a diagnostic API, do not meet this bar. In practice, this
1396-
means V8 is not updated on a release line after it enters LTS.
1391+
when there is no way to make the change without breaking the ABI. Breaking
1392+
changes that are not necessary for an LTS line, such as adding fields to a
1393+
struct to expose more information in a diagnostic API, do not meet this bar,
1394+
and should be reworked as non-breaking changes before they could land. In
1395+
practice, this means V8 is generally stable on a release line after it enters
1396+
LTS, and no ABI or API breaking changes
1397+
are expected unless in exceptional circumstances.
13971398

13981399
This policy applies to addons that depend on V8, Node.js, or other non-Node-API
13991400
native interfaces. Node-API remains the recommended interface for native addons

0 commit comments

Comments
 (0)