Skip to content

Commit 1bdc758

Browse files
committed
Prepare release 3.1.0.
1 parent ff642c5 commit 1bdc758

File tree

3 files changed

+114
-2
lines changed

3 files changed

+114
-2
lines changed

CHANGELOG.md

+76
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,81 @@
11
# node-addon-api Changelog
22

3+
## 2020-12-17 Version 3.1.0, @NickNaso
4+
5+
### Notable changes:
6+
7+
#### API
8+
9+
- Added `Napi::TypedThreadSafeFunction` class that is a new implementation for
10+
thread-safe functions.
11+
- Fixed leak on `Napi::AsyncProgressWorkerBase`.
12+
- Fixed empty data on `Napi::AsyncProgressWorker::OnProgress` caused by race
13+
conditions of `Napi::AsyncProgressWorker`.
14+
- Added `Napi::ArrayBuffer::Detach()` and `Napi::ArrayBuffer::IsDetached()`.
15+
- Fixed problem on `Napi::FinalizeCallback` it needs to create a
16+
`Napi::HandleScope` when it calls `Napi::ObjectWrap::~ObjectWrap()`.
17+
18+
#### Documentation
19+
20+
- Added documentation for `Napi::TypedThreadSafeFunction`.
21+
- Removed unsued Doxygen file.
22+
- Clarified when to use N-API.
23+
- Added support information.
24+
- Some minor corrections all over the documentation.
25+
26+
#### TEST
27+
28+
- Added test for `Napi::TypedThreadSafeFunction`.
29+
- Fixed testing for specific N-API version.
30+
- Some minor corrections all over the test suite.
31+
32+
### TOOL
33+
34+
- Setup github actions for tests.
35+
- Added stale action.
36+
- Removed `sudo` tag from Travis CI.
37+
- Added clang-format.
38+
- Added pre-commit package for linting.
39+
40+
### Commits
41+
42+
* [[`ff642c5b85`](https://github.com/nodejs/node-addon-api/commit/ff642c5b85)] - **doc**: fix tsfn docs to reflect true implementation (#860) (Kevin Eady)
43+
* [[`86feeebf54`](https://github.com/nodejs/node-addon-api/commit/86feeebf54)] - **src**: empty data OnProgress in AsyncProgressWorker (legendecas) [#853](https://github.com/nodejs/node-addon-api/pull/853)
44+
* [[`a7fb5fb31c`](https://github.com/nodejs/node-addon-api/commit/a7fb5fb31c)] - **action**: add stale action (#856) (Michael Dawson)
45+
* [[`fd44609885`](https://github.com/nodejs/node-addon-api/commit/fd44609885)] - **chore**: setup github actions for tests (#854) (legendecas) [#854](https://github.com/nodejs/node-addon-api/pull/854)
46+
* [[`c52ace4813`](https://github.com/nodejs/node-addon-api/commit/c52ace4813)] - **script**: fix complains that js files are not supported on npm run lint:fix (#852) (legendecas)
47+
* [[`b4a3364ad5`](https://github.com/nodejs/node-addon-api/commit/b4a3364ad5)] - **doc**: remove unused Doxygen file (#851) (Michael Dawson)
48+
* [[`b810466ae2`](https://github.com/nodejs/node-addon-api/commit/b810466ae2)] - **doc**: clarify when to use N-API (#849) (Michael Dawson)
49+
* [[`528b9f6832`](https://github.com/nodejs/node-addon-api/commit/528b9f6832)] - **test**: remove sudo from travis (#850) (Michael Dawson)
50+
* [[`4bb680de4e`](https://github.com/nodejs/node-addon-api/commit/4bb680de4e)] - Remove misleading sentence (#847) (Nikolai Vavilov) [#847](https://github.com/nodejs/node-addon-api/pull/847)
51+
* [[`48e6b584a3`](https://github.com/nodejs/node-addon-api/commit/48e6b584a3)] - Merge pull request #742 from KevinEady/contexted-tsfn-api-gcc-4 (Gabriel Schulhof)
52+
* [[`d5e37210cc`](https://github.com/nodejs/node-addon-api/commit/d5e37210cc)] - **tools**: print more instructions on clang-format check failed (#846) (legendecas) [#846](https://github.com/nodejs/node-addon-api/pull/846)
53+
* [[`d9e11ff2c9`](https://github.com/nodejs/node-addon-api/commit/d9e11ff2c9)] - **doc**: add support info (#843) (Michael Dawson) [#843](https://github.com/nodejs/node-addon-api/pull/843)
54+
* [[`356e93d69a`](https://github.com/nodejs/node-addon-api/commit/356e93d69a)] - **test**: fixup testing for specific N-API version (#840) (Michael Dawson) [#840](https://github.com/nodejs/node-addon-api/pull/840)
55+
* [[`5e5b9ce1b7`](https://github.com/nodejs/node-addon-api/commit/5e5b9ce1b7)] - Apply formatting changes (Kevin Eady)
56+
* [[`559ad8c0c0`](https://github.com/nodejs/node-addon-api/commit/559ad8c0c0)] - Merge remote-tracking branch 'upstream/master' into contexted-tsfn-api-gcc-4 (Kevin Eady)
57+
* [[`c24c455ced`](https://github.com/nodejs/node-addon-api/commit/c24c455ced)] - Rename to TypedThreadSafeFunction (Kevin Eady)
58+
* [[`63b43f4125`](https://github.com/nodejs/node-addon-api/commit/63b43f4125)] - **test**: fix buildType bug objectwrap\_worker\_thread (raisinten) [#837](https://github.com/nodejs/node-addon-api/pull/837)
59+
* [[`6321f2ba1a`](https://github.com/nodejs/node-addon-api/commit/6321f2ba1a)] - **test**: fix typos in addon\_build/index.js (raisinten) [#838](https://github.com/nodejs/node-addon-api/pull/838)
60+
* [[`59c6a6aeb0`](https://github.com/nodejs/node-addon-api/commit/59c6a6aeb0)] - **fix**: git-clang-format doesn't recognize no changes requested on given files (#835) (legendecas)
61+
* [[`1427b3ef78`](https://github.com/nodejs/node-addon-api/commit/1427b3ef78)] - **src**: create a HandleScope in FinalizeCallback (blagoev) [#832](https://github.com/nodejs/node-addon-api/pull/832)
62+
* [[`8fb5820557`](https://github.com/nodejs/node-addon-api/commit/8fb5820557)] - **build**: add incremental clang-format checks (legendecas) [#819](https://github.com/nodejs/node-addon-api/pull/819)
63+
* [[`2c02d317e5`](https://github.com/nodejs/node-addon-api/commit/2c02d317e5)] - **build**: add pre-commit package for linting (#823) (Kevin Eady)
64+
* [[`1b52c28eb8`](https://github.com/nodejs/node-addon-api/commit/1b52c28eb8)] - Clean up AsyncProgressWorker documentation (#831) (mastergberry)
65+
* [[`4abe7cfe30`](https://github.com/nodejs/node-addon-api/commit/4abe7cfe30)] - **test**: rename tsfnex test files (Kevin Eady)
66+
* [[`c9563caa25`](https://github.com/nodejs/node-addon-api/commit/c9563caa25)] - **src**: add ArrayBuffer::Detach() and ::IsDetached() (Tobias Nießen) [#659](https://github.com/nodejs/node-addon-api/pull/659)
67+
* [[`c79cabaed2`](https://github.com/nodejs/node-addon-api/commit/c79cabaed2)] - **doc**: avoid directing users to HTTP (#828) (Tobias Nießen)
68+
* [[`7a13f861ab`](https://github.com/nodejs/node-addon-api/commit/7a13f861ab)] - **doc**: fix additional typo (Kevin Eady)
69+
* [[`7ec9741dd2`](https://github.com/nodejs/node-addon-api/commit/7ec9741dd2)] - Merge remote-tracking branch 'upstream/master' into contexted-tsfn-api-gcc-4 (Kevin Eady)
70+
* [[`f5fad239fa`](https://github.com/nodejs/node-addon-api/commit/f5fad239fa)] - Update object\_reference.md (#827) (kidneysolo)
71+
* [[`35b65712c2`](https://github.com/nodejs/node-addon-api/commit/35b65712c2)] - **Fix**: some typos in documentation (#826) (Helio Frota)
72+
* [[`8983383000`](https://github.com/nodejs/node-addon-api/commit/8983383000)] - **Fix**: some typos in the document (#825) (Ziqiu Zhao)
73+
* [[`826e466ef6`](https://github.com/nodejs/node-addon-api/commit/826e466ef6)] - Fixed example in addon.md. (#820) (nempoBu4) [#820](https://github.com/nodejs/node-addon-api/pull/820)
74+
* [[`b54f5eb788`](https://github.com/nodejs/node-addon-api/commit/b54f5eb788)] - Additional changes from review (Kevin Eady)
75+
* [[`59f27dac9a`](https://github.com/nodejs/node-addon-api/commit/59f27dac9a)] - Fix common.gypi (Kevin Eady)
76+
* [[`151a914c99`](https://github.com/nodejs/node-addon-api/commit/151a914c99)] - Apply documentation suggestions from code review (Kevin Eady)
77+
* [[`ceb27d4949`](https://github.com/nodejs/node-addon-api/commit/ceb27d4949)] - **src**: fix leak in AsyncProgressWorkerBase\<DataType\> (Ferdinand Holzer) [#795](https://github.com/nodejs/node-addon-api/pull/795)
78+
379
## 2020-09-18 Version 3.0.2, @NickNaso
480

581
### Notable changes:

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ and node-addon-api.
5959
- **[Contributors](#contributors)**
6060
- **[License](#license)**
6161

62-
## **Current version: 3.0.2**
62+
## **Current version: 3.1.0**
6363

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

package.json

+37-1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@
5151
"name": "Bill Gallafent",
5252
"url": "https://github.com/gallafent"
5353
},
54+
{
55+
"name": "blagoev",
56+
"url": "https://github.com/blagoev"
57+
},
5458
{
5559
"name": "Bruce A. MacNaughton",
5660
"url": "https://github.com/bmacnaughton"
@@ -63,6 +67,10 @@
6367
"name": "Daniel Bevenius",
6468
"url": "https://github.com/danbev"
6569
},
70+
{
71+
"name": "Darshan Sen",
72+
"url": "https://github.com/RaisinTen"
73+
},
6674
{
6775
"name": "David Halls",
6876
"url": "https://github.com/davedoesdev"
@@ -75,6 +83,10 @@
7583
"name": "Dongjin Na",
7684
"url": "https://github.com/nadongguri"
7785
},
86+
{
87+
"name": "Ferdinand Holzer",
88+
"url": "https://github.com/fholzer"
89+
},
7890
{
7991
"name": "Eric Bickle",
8092
"url": "https://github.com/ebickle"
@@ -91,6 +103,10 @@
91103
"name": "Gus Caplan",
92104
"url": "https://github.com/devsnek"
93105
},
106+
{
107+
"name": "Helio Frota",
108+
"url": "https://github.com/helio-frota"
109+
},
94110
{
95111
"name": "Hitesh Kanwathirtha",
96112
"url": "https://github.com/digitalinfinity"
@@ -139,6 +155,10 @@
139155
"name": "Kevin Eady",
140156
"url": "https://github.com/KevinEady"
141157
},
158+
{
159+
"name": "kidneysolo",
160+
"url": "https://github.com/kidneysolo"
161+
},
142162
{
143163
"name": "Koki Nishihara",
144164
"url": "https://github.com/Nishikoh"
@@ -163,6 +183,10 @@
163183
"name": "Luciano Martorella",
164184
"url": "https://github.com/lmartorella"
165185
},
186+
{
187+
"name": "mastergberry",
188+
"url": "https://github.com/mastergberry"
189+
},
166190
{
167191
"name": "Mathias Küsel",
168192
"url": "https://github.com/mathiask88"
@@ -187,6 +211,10 @@
187211
"name": "Mikhail Cheshkov",
188212
"url": "https://github.com/mcheshkov"
189213
},
214+
{
215+
"name": "nempoBu4",
216+
"url": "https://github.com/nempoBu4"
217+
},
190218
{
191219
"name": "Nicola Del Gobbo",
192220
"url": "https://github.com/NickNaso"
@@ -195,6 +223,10 @@
195223
"name": "Nick Soggin",
196224
"url": "https://github.com/iSkore"
197225
},
226+
{
227+
"name": "Nikolai Vavilov",
228+
"url": "https://github.com/seishun"
229+
},
198230
{
199231
"name": "Nurbol Alpysbayev",
200232
"url": "https://github.com/anurbol"
@@ -258,6 +290,10 @@
258290
{
259291
"name": "Yulong Wang",
260292
"url": "https://github.com/fs-eire"
293+
},
294+
{
295+
"name": "Ziqiu Zhao",
296+
"url": "https://github.com/ZzqiZQute"
261297
}
262298
],
263299
"dependencies": {},
@@ -307,6 +343,6 @@
307343
"lint:fix": "git-clang-format '*.h', '*.cc'"
308344
},
309345
"pre-commit": "lint",
310-
"version": "3.0.2",
346+
"version": "3.1.0",
311347
"support": true
312348
}

0 commit comments

Comments
 (0)