Skip to content

Commit c32e8e7

Browse files
committed
chore: update release document
1 parent cc06369 commit c32e8e7

File tree

4 files changed

+30
-13
lines changed

4 files changed

+30
-13
lines changed

.github/workflows/release-please.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on:
44
push:
55
branches:
66
- main
7+
workflow_dispatch:
78

89
jobs:
910
release-please:
@@ -15,6 +16,7 @@ jobs:
1516
id: release
1617
with:
1718
release-type: node
19+
manifest-file: .release-please-manifest.json
1820

1921
npm-publish:
2022
needs: release-please

.release-please-manifest.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"pull-request-title-pattern": "chore: release v${version}",
3+
"extra-files": [
4+
"README.md"
5+
]
6+
}

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,24 @@ the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.
99
provided by Node.js when using C++. It provides a C++ object model
1010
and exception handling semantics with low overhead.
1111

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+
1220
- [API References](doc/README.md)
1321
- [Badges](#badges)
1422
- [Contributing](#contributing)
1523
- [License](#license)
1624

17-
## API References
18-
19-
API references are available in the [doc](doc/README.md) directory.
20-
21-
## Current version: 8.0.0
22-
2325
(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
2426

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
2928

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.
3130

3231
## Badges
3332

doc/contributing/creating_a_release.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,17 @@ collaborators to add you. If necessary you can ask the build
66
Working Group who manages the Node.js npm user to add you if
77
there are no other active collaborators.
88

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
1020

1121
Before to start creating a new release check if you have installed the following
1222
tools:
@@ -16,7 +26,7 @@ tools:
1626
If not please follow the instruction reported in the tool's documentation to
1727
install it.
1828

19-
## Publish new release
29+
### Steps
2030

2131
These are the steps to follow to create a new release:
2232

0 commit comments

Comments
 (0)