Skip to content

Commit

Permalink
chore: update release document
Browse files Browse the repository at this point in the history
  • Loading branch information
legendecas committed Jul 4, 2024
1 parent cc06369 commit c32e8e7
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 13 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
workflow_dispatch:

jobs:
release-please:
Expand All @@ -15,6 +16,7 @@ jobs:
id: release
with:
release-type: node
manifest-file: .release-please-manifest.json

npm-publish:
needs: release-please
Expand Down
6 changes: 6 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"pull-request-title-pattern": "chore: release v${version}",
"extra-files": [
"README.md"
]
}
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,24 @@ the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.
provided by Node.js when using C++. It provides a C++ object model
and exception handling semantics with low overhead.

node-addon-api allows addons to run with Node.js versions which support the targeted Node-API version.
**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that
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 supported by the current version of node-addon-api is Node.js 18.x.

Current version: 8.0.0 <!-- x-release-please-version -->

- [API References](doc/README.md)
- [Badges](#badges)
- [Contributing](#contributing)
- [License](#license)

## API References

API references are available in the [doc](doc/README.md) directory.

## Current version: 8.0.0

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

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

The oldest Node.js version supported by the current version of node-addon-api is Node.js 18.x.
API references are available in the [doc](doc/README.md) directory.

## Badges

Expand Down
14 changes: 12 additions & 2 deletions doc/contributing/creating_a_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,17 @@ collaborators to add you. If necessary you can ask the build
Working Group who manages the Node.js npm user to add you if
there are no other active collaborators.

## Prerequisites
Generally, the release is handled by the
[release-please](https://github.com/nodejs/node-addon-api/blob/main/.github/workflows/release-please.yml)
GitHub action. It will bump the version in `package.json` and publish
node-addon-api to npm.

In cases that the release-please action is not working, please follow the steps
below to publish node-addon-api manually.

## Publish new release manually

### Prerequisites

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

## Publish new release
### Steps

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

Expand Down

0 comments on commit c32e8e7

Please sign in to comment.