Skip to main content

Writing release notes

Pulsar release notes consist of the following parts:

Prerequisite​

To generate release notes, you are suggested to install the GitHub CLI and authenticate first:

brew install gh
gh auth login

Fetch the release metadata​

# Replace v2.10.2 with the target version tag
# Replace apache/pulsar with the component repo
gh release view "v2.10.2" -R apache/pulsar --json author,tagName,publishedAt

Fetch the release note​

# Replace v2.10.2 with the target version tag
# Replace apache/pulsar with the component repo
gh release view "v2.10.2" -R apache/pulsar --json body --jq .body

Update the release note page​

  1. Copy the related release notes entries and add a versioned release note file.
  2. Update the version metadata files (release-*.js).

To preview the result, follow the instructions for previewing content.

Submit the release note​

Submit a PR against the site repo with the added version release note file and updated version metadata files.

Here are some examples:

Check whether the release information is shown on the Pulsar Release Note page after the website is updated and built successfully.

Was this helpful?