Skip to content

Commit 7024b84

Browse files
authored
chore: update release document (#1531)
1 parent b8525e2 commit 7024b84

File tree

4 files changed

+22
-2
lines changed

4 files changed

+22
-2
lines changed

.github/workflows/release-please.yml

+2
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

+6
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

+2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ and exception handling semantics with low overhead.
1818

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

21+
<!-- x-release-please-start-version -->
2122
## Current version: 8.0.0
23+
<!-- x-release-please-end -->
2224

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

doc/contributing/creating_a_release.md

+12-2
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)