Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into pip-264-topic-lookup-…
Browse files Browse the repository at this point in the history
…metrics
  • Loading branch information
dragosvictor committed Mar 14, 2024
2 parents cfd208c + 7dd58e6 commit 6c56b43
Show file tree
Hide file tree
Showing 122 changed files with 416,092 additions and 151 deletions.
24 changes: 23 additions & 1 deletion contribute/release-note-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,31 @@ gh release view "v2.10.2" -R apache/pulsar --json author,tagName,publishedAt
gh release view "v2.10.2" -R apache/pulsar --json body --jq .body
```


## Generate release notes

There isn't a definite way yet.

Here are 2 approaches:

Using "git log"

```bash
git log --reverse --oneline v2.11.3..v2.11.4 | colrm 1 12 | sed 's/\] \[/][/' | perl -p -e 's/^\s+//' | sort
```

Alternatively using "gh pr list"

```bash
gh pr list -L 1000 --search "is:pr is:merged label:release/2.10.6 label:cherry-picked/branch-2.10" --json title,number,url | jq -r '.[] | "\(.title) [\(.number)](\(.url))"'
```

## Update the release note page

1. Copy the related release notes entries and add a [versioned release note file](https://github.com/apache/pulsar-site/tree/main/release-notes/versioned).
2. Update the [version metadata files](https://github.com/apache/pulsar-site/tree/main/data) (`release-*.js`).
2. Update the [version metadata files](https://github.com/apache/pulsar-site/tree/main/data) (`release-*.js`). For apache/pulsar releases, this means updating `release-java.js` (Java client) and `release-pulsar.js` (Pulsar).
3. For every apache/pulsar release, you should add a `<release-version>` entry to the corresponding place in the `releases.json` file.
4. Update swagger files. ref: [swagger files](https://pulsar.apache.org/contribute/release-process/#swagger-files)

To preview the result, follow the instructions for [previewing content](document-preview.md#preview-changes).

Expand All @@ -54,5 +75,6 @@ Here are some examples:

* [Add the release note for C++ client 3.1.0](https://github.com/apache/pulsar-site/pull/326)
* [Add the release note for Python client 3.0.0](https://github.com/apache/pulsar-site/pull/343)
* [Add the release note for Pulsar 3.0.3](https://github.com/apache/pulsar-site/pull/834)

Check whether the release information is shown on the [Pulsar Release Note page](pathname:///release-notes/) after the website is updated and built successfully.
Loading

0 comments on commit 6c56b43

Please sign in to comment.