You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by yh...@apache.org on 2024/10/01 18:07:53 UTC

(beam) branch master updated: Update Release guide with new github release guidance. (#32576)

This is an automated email from the ASF dual-hosted git repository.

yhu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git


The following commit(s) were added to refs/heads/master by this push:
     new 6a7ffa587df Update Release guide with new github release guidance. (#32576)
6a7ffa587df is described below

commit 6a7ffa587df5eac1e3a3886152891f750638dc85
Author: Robert Burke <lo...@users.noreply.github.com>
AuthorDate: Tue Oct 1 11:07:46 2024 -0700

    Update Release guide with new github release guidance. (#32576)
    
    Co-authored-by: lostluck <13...@users.noreply.github.com>
---
 contributor-docs/release-guide.md | 36 ++++++++++++++++++++++++++----------
 1 file changed, 26 insertions(+), 10 deletions(-)

diff --git a/contributor-docs/release-guide.md b/contributor-docs/release-guide.md
index f18d734b506..4fe35aa4aac 100644
--- a/contributor-docs/release-guide.md
+++ b/contributor-docs/release-guide.md
@@ -608,8 +608,12 @@ as an example.
 
 > **TIP**
 > Use git log to find contributors to the releases. (e.g: `git fetch
-> origin --tags; git log --pretty='%aN' ^v2.10.0 v2.11.0-RC1 | sort | uniq`).
+> origin --tags; git log --pretty='%aN' ^v2.10.0 v2.11.0-RC1 | sort | uniq | tr '\n' ',' | sed 's/,/, /g' | sed 's/..$/\n/'`).
 > Make sure to clean it up, as there may be duplicate or incorrect user names.
+>
+> The command gets all pretty printed names from git, sorts them, de-duplicates them,
+> replaces newlines with commas, replaces all commas with a comma and a space, and
+> and finally strips the trailing comma, and adds a final line break for easier copying.
 
 > **NOTE**
 > Make sure to include any breaking changes, even to `@Experimental`
@@ -689,6 +693,15 @@ as an example.
     ${CONTRIBUTORS}
 
 
+### Update the Github Release with the Blog post content
+
+Use the content of the blog post as the description of the release.
+
+You may now also uncheck the "draft" checkbox.
+This allows it to be visible to non-committers, and makes the assets publically accessible.
+
+Be sure the release is still marked as a pre-release (not as latest).
+
 ### Checklist to proceed to the next phase
 
 - [ ] Maven artifacts deployed to the staging repository of
@@ -702,6 +715,7 @@ as an example.
 - [ ] Docker images are published to
   [DockerHub](https://hub.docker.com/search?q=apache%2Fbeam&type=image) with
   tags: `{RELEASE_VERSION}rc{RC_NUM}`.
+- [ ] Github Release page contains the blog post.
 
 You can (optionally) also do additional verification by:
 
@@ -756,6 +770,7 @@ template; please adjust as you see fit.
     * Validation sheet with a tab for 1.2.3 release to help with validation [10].
     * Docker images published to Docker Hub [11].
     * PR to run tests against release branch [12].
+    * Github Release pre-release page for v1.2.3-RC3 [13].
 
     The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes.
 
@@ -776,7 +791,8 @@ template; please adjust as you see fit.
     [10] https://docs.google.com/spreadsheets/d/1qk-N5vjXvbcEk68GjbkSZTR8AGqyNUM-oLFo_ZXBpJw/edit#gid=...
     [11] https://hub.docker.com/search?q=apache%2Fbeam&type=image
     [12] https://github.com/apache/beam/pull/...
-    [13] https://github.com/apache/beam/blob/master/contributor-docs/rc-testing-guide.md
+    [13] https://github.com/apache/beam/releases/tag/v1.2.3-RC3
+    [14] https://github.com/apache/beam/blob/master/contributor-docs/rc-testing-guide.md
 
 If there are any issues found in the release candidate, reply on the vote
 thread to cancel the vote.  There’s no need to wait 72 hours. Go back to
@@ -1136,16 +1152,16 @@ Merge all of the website pull requests
 - publishing the [Python API reference manual](https://beam.apache.org/releases/pydoc/) and the [Java API reference manual](https://beam.apache.org/releases/javadoc/), and
 - adding the release blog post.
 
-### Publish release to Github
+### Publish the Github Release page
+
+Once the tag is uploaded, update the page with the final release tag, and publish the release notes to Github.
 
-Once the tag is uploaded, publish the release notes to Github.
-From the [Beam release page on Github](https://github.com/apache/beam/releases)
+* From the [Beam release page on Github](https://github.com/apache/beam/releases)
 find and open the release for the final RC tag for for editing.
-Update the release with the final version tag created above.
-Use the content of the release blog post as the body of the release notes,
-set this version as the latest release, and publish it.
+* Update the release with the final version tag created above.
+* Set this version as the latest release, and publish it.
 
-The release notes should now be visible on Github's [Releases](https://github.com/apache/beam/releases) page.
+The release notes should now be visible on Github's [Releases](https://github.com/apache/beam/releases) page with the correct version.
 
 ### Mark the version as released in GitHub
 
@@ -1414,4 +1430,4 @@ Or:
 Hi everyone,
 Please review and vote on the release candidate #1 for the version 2.XX.1. Given the time sensitive nature of patch releases, I will finalize the release as soon as I have 3 binding approvals AND at least 24 hours have passed.
 …
-```
\ No newline at end of file
+```