File tree Expand file tree Collapse file tree 4 files changed +30
-13
lines changed Expand file tree Collapse file tree 4 files changed +30
-13
lines changed Original file line number Diff line number Diff line change 4
4
push :
5
5
branches :
6
6
- main
7
+ workflow_dispatch :
7
8
8
9
jobs :
9
10
release-please :
15
16
id : release
16
17
with :
17
18
release-type : node
19
+ manifest-file : .release-please-manifest.json
18
20
19
21
npm-publish :
20
22
needs : release-please
Original file line number Diff line number Diff line change
1
+ {
2
+ "pull-request-title-pattern" : " chore: release v${version}" ,
3
+ "extra-files" : [
4
+ " README.md"
5
+ ]
6
+ }
Original file line number Diff line number Diff line change @@ -9,25 +9,24 @@ the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.
9
9
provided by Node.js when using C++. It provides a C++ object model
10
10
and exception handling semantics with low overhead.
11
11
12
+ node-addon-api allows addons to run with Node.js versions which support the targeted Node-API version.
13
+ ** However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
14
+ every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
15
+
16
+ The oldest Node.js version supported by the current version of node-addon-api is Node.js 18.x.
17
+
18
+ Current version: 8.0.0 <!-- x-release-please-version -->
19
+
12
20
- [ API References] ( doc/README.md )
13
21
- [ Badges] ( #badges )
14
22
- [ Contributing] ( #contributing )
15
23
- [ License] ( #license )
16
24
17
- ## API References
18
-
19
- API references are available in the [ doc] ( doc/README.md ) directory.
20
-
21
- ## Current version: 8.0.0
22
-
23
25
(See [ CHANGELOG.md] ( CHANGELOG.md ) for complete Changelog)
24
26
25
- node-addon-api is based on [ Node-API] ( https://nodejs.org/api/n-api.html ) and supports using different Node-API versions.
26
- This allows addons built with it to run with Node.js versions which support the targeted Node-API version.
27
- ** However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
28
- every year there will be a new major which drops support for the Node.js LTS version which has gone out of service.
27
+ ## API References
29
28
30
- The oldest Node.js version supported by the current version of node-addon-api is Node.js 18.x .
29
+ API references are available in the [ doc ] ( doc/README.md ) directory .
31
30
32
31
## Badges
33
32
Original file line number Diff line number Diff line change @@ -6,7 +6,17 @@ collaborators to add you. If necessary you can ask the build
6
6
Working Group who manages the Node.js npm user to add you if
7
7
there are no other active collaborators.
8
8
9
- ## Prerequisites
9
+ Generally, the release is handled by the
10
+ [ release-please] ( https://github.com/nodejs/node-addon-api/blob/main/.github/workflows/release-please.yml )
11
+ GitHub action. It will bump the version in ` package.json ` and publish
12
+ node-addon-api to npm.
13
+
14
+ In cases that the release-please action is not working, please follow the steps
15
+ below to publish node-addon-api manually.
16
+
17
+ ## Publish new release manually
18
+
19
+ ### Prerequisites
10
20
11
21
Before to start creating a new release check if you have installed the following
12
22
tools:
16
26
If not please follow the instruction reported in the tool's documentation to
17
27
install it.
18
28
19
- ## Publish new release
29
+ ### Steps
20
30
21
31
These are the steps to follow to create a new release:
22
32
You can’t perform that action at this time.
0 commit comments