Skip to content

Add api docs section for release process. #365

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.

Sign up for GitHub

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

Merged
shibd merged 1 commit into from
Mar 5, 2024
Merged

Add api docs section for release process. #365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion docs/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down