chore: update release document (#1531)
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 5282ce3..40f3b66 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml
@@ -4,6 +4,7 @@ push: branches: - main + workflow_dispatch: jobs: release-please: @@ -15,6 +16,7 @@ id: release with: release-type: node + manifest-file: .release-please-manifest.json npm-publish: needs: release-please
diff --git a/.release-please-manifest.json b/.release-please-manifest.json new file mode 100644 index 0000000..13464ff --- /dev/null +++ b/.release-please-manifest.json
@@ -0,0 +1,6 @@ +{ + "pull-request-title-pattern": "chore: release v${version}", + "extra-files": [ + "README.md" + ] +}
diff --git a/README.md b/README.md index 9357de3..97f50ef 100644 --- a/README.md +++ b/README.md
@@ -18,7 +18,9 @@ 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)
diff --git a/doc/contributing/creating_a_release.md b/doc/contributing/creating_a_release.md index f263dc3..02e9cbc 100644 --- a/doc/contributing/creating_a_release.md +++ b/doc/contributing/creating_a_release.md
@@ -6,7 +6,17 @@ 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: @@ -16,7 +26,7 @@ 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: