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.

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

chore: update release document #1531

Merged
merged 1 commit into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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"
]
}
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ and exception handling semantics with low overhead.

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

<!-- x-release-please-start-version -->
## Current version: 8.0.0
<!-- x-release-please-end -->

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

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