You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/10/11 03:38:25 UTC
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17990: [feat][doc] Add Pulsar Release Note Guide
tisonkun commented on code in PR #17990:
URL: https://github.com/apache/pulsar/pull/17990#discussion_r991782184
##########
wiki/release/release-process.md:
##########
@@ -454,7 +454,7 @@ Send out a PR request for review.
## Write release notes
-See [Pulsar Release Notes Guide](https://docs.google.com/document/d/1cwNkBefKyV6OPbEXnUrcCdVZi0i2BezqL6vAL7VqVC0/edit#).
+See [Pulsar Release Notes Guide](../release/release-note-guide.md).
Review Comment:
```suggestion
See [Pulsar Release Notes Guide](../release-note-guide.md).
```
##########
wiki/release/release-note-guide.md:
##########
@@ -0,0 +1,69 @@
+This guide explains everything about Pulsar release notes.
+
+# Intro to release notes
+
+This chapter gives an overview of Pulsar release notes.
+
+## Basic info
+
+[Pulsar release notes](https://pulsar.apache.org/release-notes/) consist of the following parts.
+
+Release note | Component
+---|---
+[Pulsar core](https://pulsar.apache.org/release-notes/#pulsar-release-notes)| Pulsar
+[Pulsar clients](../../site2/docs/client-libraries.md) |- Java <br><br> - WebSocket <br><br> - C++ <br><br> - Python <br><br> - Go <br><br> - NodeJs <br><br> - C#
+
+## Maintenance info
+
+For the [Pulsar Release Note page](https://pulsar.apache.org/release-notes/):
+
+- It is generated automatically using [release-json-gen.sh](https://github.com/apache/pulsar-site/blob/main/site2/tools/release-json-gen.sh).
+
+ For implementation details, see [PIP 112: Generate Release Notes Automatically](https://github.com/apache/pulsar/wiki/PIP-112:-Generate-Release-Notes-Automatically).
+
+- The info is fetched from the [Pulsar Releases Page - GitHub](https://github.com/apache/pulsar/releases).
+
+- It is updated when one of the following conditions is met:
+
+ - A commit is pushed to the [pulsar-site repo](https://github.com/apache/pulsar-site).
+
+ - A [Pulsar site sync job](https://github.com/apache/pulsar-site/actions/workflows/ci-pulsar-website-docs-sync.yaml) is performed (every 6 hours).
+
+# Submit release notes
+
+Follow the steps below to submit release notes for Pulsar and clients.
+
+1. On the [Pulsar Releases Page - GitHub](https://github.com/apache/pulsar/releases), add a release note for the new release.
+
+ <table>
+ <thead>
+ <tr>
+ <th colspan="2">Component</th>
+ <th>Step</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td colspan="2">Pulsar core</td>
+ <td>Add a release note for it.</td>
+ </tr>
+ <tr>
+ <td rowspan="2">Pulsar clients</td>
+ <td> - Java<br><br> - WebSocket<br><br> - C++<br><br> - Python</td>
+ <td>Add separate release notes for them, that is, create independent sections in the release note.<br><br>Example<br><br><img title="Java client release note example" alt="Java client release note example" src="../assets/release-note-guide-1.png"></td>
+ </tr>
+ <tr>
+ <td> - Go<br><br> - Node.js<br><br> - C#</td>
+ <td>No action is needed. You do not need to take care of them since their release notes are synced from their repos to the <a href="https://pulsar.apache.org/release-notes/">Pulsar Release Note page</a>.</td>
+ </tr>
+ </tbody>
+ </table>
Review Comment:
Perhaps transform to markdown tables?
##########
wiki/release/release-note-guide.md:
##########
@@ -0,0 +1,69 @@
+This guide explains everything about Pulsar release notes.
Review Comment:
```suggestion
# Release Note Guide
This guide explains everything about Pulsar release notes.
```
... and indent one level for all headings below.
##########
wiki/release/release-note-guide.md:
##########
@@ -0,0 +1,69 @@
+This guide explains everything about Pulsar release notes.
+
+# Intro to release notes
+
+This chapter gives an overview of Pulsar release notes.
+
+## Basic info
+
+[Pulsar release notes](https://pulsar.apache.org/release-notes/) consist of the following parts.
+
+Release note | Component
+---|---
+[Pulsar core](https://pulsar.apache.org/release-notes/#pulsar-release-notes)| Pulsar
+[Pulsar clients](../../site2/docs/client-libraries.md) |- Java <br><br> - WebSocket <br><br> - C++ <br><br> - Python <br><br> - Go <br><br> - NodeJs <br><br> - C#
+
+## Maintenance info
+
+For the [Pulsar Release Note page](https://pulsar.apache.org/release-notes/):
+
+- It is generated automatically using [release-json-gen.sh](https://github.com/apache/pulsar-site/blob/main/site2/tools/release-json-gen.sh).
+
+ For implementation details, see [PIP 112: Generate Release Notes Automatically](https://github.com/apache/pulsar/wiki/PIP-112:-Generate-Release-Notes-Automatically).
+
+- The info is fetched from the [Pulsar Releases Page - GitHub](https://github.com/apache/pulsar/releases).
+
+- It is updated when one of the following conditions is met:
+
+ - A commit is pushed to the [pulsar-site repo](https://github.com/apache/pulsar-site).
+
+ - A [Pulsar site sync job](https://github.com/apache/pulsar-site/actions/workflows/ci-pulsar-website-docs-sync.yaml) is performed (every 6 hours).
+
+# Submit release notes
+
+Follow the steps below to submit release notes for Pulsar and clients.
+
+1. On the [Pulsar Releases Page - GitHub](https://github.com/apache/pulsar/releases), add a release note for the new release.
+
+ <table>
+ <thead>
+ <tr>
+ <th colspan="2">Component</th>
+ <th>Step</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td colspan="2">Pulsar core</td>
+ <td>Add a release note for it.</td>
+ </tr>
+ <tr>
+ <td rowspan="2">Pulsar clients</td>
+ <td> - Java<br><br> - WebSocket<br><br> - C++<br><br> - Python</td>
+ <td>Add separate release notes for them, that is, create independent sections in the release note.<br><br>Example<br><br><img title="Java client release note example" alt="Java client release note example" src="../assets/release-note-guide-1.png"></td>
+ </tr>
+ <tr>
+ <td> - Go<br><br> - Node.js<br><br> - C#</td>
+ <td>No action is needed. You do not need to take care of them since their release notes are synced from their repos to the <a href="https://pulsar.apache.org/release-notes/">Pulsar Release Note page</a>.</td>
+ </tr>
+ </tbody>
+ </table>
+
+ After the new release is published, all the information about the release is automatically added to the [Pulsar Release Note page](https://pulsar.apache.org/release-notes/).
+
+2. Check whether the release information is shown on the [Pulsar Release Note page](https://pulsar.apache.org/release-notes/) after the website is updated and built successfully.
+
+
+
+
+
Review Comment:
```suggestion
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org