Skip to content
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

doc: Removed references to Node.js lower than 10.x. #709

Merged
merged 7 commits into from
Apr 29, 2020
+14 −7
Merged

doc: Removed references to Node.js lower than 10.x. #709

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
30e833e
Removed references to Node.js lower than 10.x.
NickNaso Apr 27, 2020
83c41de
squash: state supported Node.js versions
mhdawson Apr 27, 2020
dbbd4ae
Update README.md
mhdawson Apr 27, 2020
53518c8
Update README.md
mhdawson Apr 27, 2020
0f5b037
Update README.md
mhdawson Apr 27, 2020
500fdf7
Update README.md
mhdawson Apr 27, 2020
cd591c1
Apply suggestions from code review
NickNaso Apr 27, 2020
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
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It is important to remember that *other* Node.js interfaces such as
`libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api`
exclusively and build against a version of Node.js that includes an
implementation of N-API (meaning a version of Node.js newer than 6.14.2) in
implementation of N-API (meaning an active LTS version of Node.js) in
order to benefit from ABI stability across Node.js major versions. Node.js
provides an [ABI stability guide][] containing a detailed explanation of ABI
stability in general, and the N-API ABI stability guarantee in particular.
Expand All @@ -47,14 +47,21 @@ to ideas specified in the **ECMA262 Language Specification**.
- **[Contributors](#contributors)**
- **[License](#license)**

## **Current version: 2.0.0**
## **Current version: 3.0.0**

(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)

[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/)

<a name="setup"></a>

node-addon-api is based on [N-API](https://nodejs.org/api/n-api.html) and supports using different N-API versions.
This allows addons built with it to run with Node.js versions which support the targetted N-API version.
NickNaso marked this conversation as resolved.
Show resolved Hide resolved
**However** node-addon-api the support model is to support only the active LTS Node.js versions. This means that
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.

The oldest Node.js version that the current node-addon-version supports is currently Node.js 10.x.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved

## Setup
- [Installation and usage](doc/setup.md)
- [node-gyp](doc/node-gyp.md)
Expand Down
10 changes: 5 additions & 5 deletions doc/creating_a_release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ tools:

* [Changelog maker](https://www.npmjs.com/package/changelog-maker)

If not please follow the instruction reported in the tool's documentation to
If not please follow the instruction reported in the tool's documentation to
install it.

## Publish new release
Expand All @@ -27,13 +27,13 @@ new release. Give people some time to comment or suggest PRs that should land fi

* Update the version in **package.json** appropriately.

* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md)
* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md)
to show the new version as the latest.

* Generate the changelog for the new version using **changelog maker** tool. From
the route folder of the repo launch the following command:

```bash
```bash
> changelog-maker
```
* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
Expand All @@ -43,8 +43,8 @@ following the style used in publishing the previous release.

* Validate all tests pass by running npm test on master.

* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)**
to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and
* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/)**
to validate tests pass (note there are still some issues on SmartOS and
Windows in the testing).

* Do a clean checkout of node-addon-api.
Expand Down