This is an automated email from the ASF dual-hosted git repository.
baodi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-client-node.git
The following commit(s) were added to refs/heads/master by this push:
new 5f92d05 Add api docs section for release process. (#365)
5f92d05 is described below
commit 5f92d051f858d4b9219e36d4be87745f1d48ce82
Author: Baodi Shi <[email protected]>
AuthorDate: Tue Mar 5 19:31:56 2024 +0800
Add api docs section for release process. (#365)
---
docs/release-process.md | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/release-process.md b/docs/release-process.md
index fb48977..d30f7a0 100644
--- a/docs/release-process.md
+++ b/docs/release-process.md
@@ -253,7 +253,15 @@ If there are any new contributors for this release, please
add a `New Contributo
Once the PR has been approved, add release notes to the Github release page
(https://github.com/apache/pulsar-client-node/releases)
-#### 10. Announce the release
+#### 10. Add api docs
+Create a PR to add api docs to the pulsar site. Here is the example:
https://github.com/apache/pulsar-site/pull/784
+
+```shell
+cd pulsar-site/tools/pytools
+poetry run bin/js-apidoc-generator.py 1.X.0
+```
+
+#### 11. Announce the release
Once the release artifact is available in the npm registry, we need to
announce the release.
