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

Jump to bottom

Update release guide somewhat according to 2.51.0 release experience #28836

Merged

kennknowles merged 1 commit into apache:master from kennknowles:release-guide

Oct 6, 2023

Member

kennknowles commented Oct 4, 2023 •

edited

Loading

This updates the release guide in a couple of major ways:

Fixes the process, which incorrectly combined the process of cutting the release branch with building an RC
Clarifies what is done by GitHub Actions and what is done by scripts
Eliminates some of the excessive verbosity about how to do things that script do (just read the script)

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
Update CHANGES.md with noteworthy changes.
If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

Member Author

kennknowles commented Oct 4, 2023

Contributor

github-actions bot commented Oct 4, 2023

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

kennknowles force-pushed the release-guide branch 3 times, most recently from 4def0e8 to 7abb17e Compare

October 5, 2023 14:20

Member Author

kennknowles commented Oct 5, 2023

OK whitespace lint fixed after the Gradle 8 upgrade. I recommend reviewing the new doc as a whole and ignoring the diff largely.

FWIW I am separately adding an idempotent markdown autoformatter to the repo.

Contributor

lostluck commented Oct 5, 2023

Gotta say, that the "Fixes the process, which incorrectly combined the process of stabilizing the release branch with building an RC" sounds like reverting the changes I made based on my 2.50.0 release experience. But I should actually read the whole thing first rather than make assumptions.

Just off hand, I don't see much of a difference between "stabilizing a release branch" and "cutting RC1".

Member Author

kennknowles commented Oct 5, 2023 •

edited

Loading

That was a brain-o on my part. Incorrectly combined cutting the release branch with stabilizing and then cutting an RC. It has one section that covered all that. Now cutting the branch is a phase change from "preparing" to "stabilizing", which has actually been the case for years.

I do have separate sections for "stabilizing" and the mechanics of building the RC, but that is just because they are different activities - the former being a lot of communication and cherrypicks and the latter covering just all the commands and stuff you have to run.

lostluck approved these changes

View reviewed changes

Contributor

lostluck left a comment

Other than the quibling about wording on "don't attempt to stabilize the branch before cutting", mostly minor typo/formatting fixes, with a special emphasise on getting that sweet Note rendering done evenly through the doc.

contributor-docs/release-guide.md


		## 2. Prepare for the release (~1 week before branch cut)

Contributor

lostluck Oct 5, 2023

The ~1week bit was added in the last cycle because it would have been beneficial to have done these things the week prior to the release rather than Day of Cut. I know I benefit from the explicit timeframe indication.

Member Author

kennknowles Oct 6, 2023

Added it back.

contributor-docs/release-guide.md Outdated

    
              Milestone`](https://github.com/apache/beam/milestones).

              2. Add a new release.  Choose the next minor version number after the version

              currently underway, select the next release due date (generally 6 weeks from

              today’s date) as the `Start Date`, and choose `Create Milestone`.

Contributor

lostluck Oct 5, 2023

TBH I think we should, simply leave off the start date. Otherwise we get severe warnings in the UI once it's past that time, leading to just deleting the date entirely.

Member Author

kennknowles Oct 6, 2023

SGTM. I think I did that same thing.

contributor-docs/release-guide.md Outdated

    
              ----

              ### One-time setup instructions

               - Apache ID and Password;

Contributor

lostluck Oct 5, 2023

Suggested change

      
             - Apache ID and Password;
          
             - Apache ID and Password

Since we don't semicolon terminate everything in this list.

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md

    
               - [ ] See if https://go.dev/doc/devel/release has a newer release. Update throughout

                     Beam. See example at https://github.com/apache/beam/pull/27900/files

              See if https://go.dev/doc/devel/release has a newer release. Update throughout

              Beam. See example at https://github.com/apache/beam/pull/27900/files

Contributor

lostluck Oct 5, 2023

Nit: So that change is a bit broad since it's a major Go upgrade rather than a security patch upgrade.

Technically the containers only need to have the BeamModulePlugin.groovy changed
https://github.com/apache/beam/pull/27900/files#diff-0435a83a413ec063bf7e682cadcd56776cd18fc878f197cc99a65fc231ef2047

But based on #28843 we should probably just move this value to be canonical in gradle.properties and reduce canonical locations.

Member Author

kennknowles Oct 6, 2023

So I figure this is a better example PR than https://github.com/apache/beam/pull/28441/files for now? And yea we should follow up by having fewer places.

contributor-docs/release-guide.md Outdated

Comment on lines 160 to 161

    
              __NOTE__: When generating the key, please make sure you choose the key type as

              __RSA and RSA (default)__ and key size as __4096 bit__.

Contributor

lostluck Oct 5, 2023

We should change this to the "callout box" format used later in the doc. This just makes things bold. The latter one renders nicely according to the rich diff.

Suggested change

      
            __NOTE__: When generating the key, please make sure you choose the key type as
          
            __RSA and RSA (default)__ and key size as __4096 bit__.
          
            > **Note**
          
            > When generating the key, please make sure you choose the key type as
          
            > __RSA and RSA (default)__ and key size as __4096 bit__.

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

Comment on lines 707 to 708

    
              __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`).

Contributor

lostluck Oct 5, 2023

Suggested change

      
            __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`).
          
            > **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`).

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

Comment on lines 711 to 712

    
              __NOTE__: Make sure to include any breaking changes, even to `@Experimental`

              features, all major features and bug fixes, and all known issues.

Contributor

lostluck Oct 5, 2023

Suggested change

      
            __NOTE__: Make sure to include any breaking changes, even to `@Experimental`
          
            features, all major features and bug fixes, and all known issues.
          
            > **Note**:
          
            > Make sure to include any breaking changes, even to `@Experimental`
          
            > features, all major features and bug fixes, and all known issues.

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              For example, if an issue is found in the website pull request, just correct it on the spot and the vote can continue as-is.

              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

              "Stabilize the Release Branch" and address the problem.  However, some issues

Contributor

lostluck Oct 5, 2023

Fun fact, you could in principle make this a working link, since the heading sare auto anchored.:
/contributor-docs/release-guide.md#stabilize-the-release-branch

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              versions to run all of the tests. See Python installation tips in [Developer

              Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters).

              > **Note** the community's validation means more than just running the tests

Contributor

lostluck Oct 5, 2023

Suggested change

      
            > **Note** the community's validation means more than just running the tests
          
            > **Note**
          
            > The community's validation means more than just running the tests

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              #### Run validations manually

              _Note_: -Prepourl and -Pver can be found in the RC vote email sent by Release Manager.

              > **Note** `-Prepourl` and `-Pver` can be found in the RC vote email sent by Release Manager.

Contributor

lostluck Oct 5, 2023

Suggested change

      
            > **Note** `-Prepourl` and `-Pver` can be found in the RC vote email sent by Release Manager.
          
            > **Note**
          
            > `-Prepourl` and `-Pver` can be found in the RC vote email sent by Release Manager.

Member Author

kennknowles Oct 6, 2023

Done

kennknowles commented

View reviewed changes

Member Author

kennknowles left a comment

Thanks for such excellent attention to detail!

contributor-docs/release-guide.md


		## 2. Prepare for the release (~1 week before branch cut)

Member Author

kennknowles Oct 6, 2023

Added it back.

contributor-docs/release-guide.md Outdated

    
              Milestone`](https://github.com/apache/beam/milestones).

              2. Add a new release.  Choose the next minor version number after the version

              currently underway, select the next release due date (generally 6 weeks from

              today’s date) as the `Start Date`, and choose `Create Milestone`.

Member Author

kennknowles Oct 6, 2023

SGTM. I think I did that same thing.

contributor-docs/release-guide.md Outdated

    
              ----

              ### One-time setup instructions

               - Apache ID and Password;

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

Comment on lines 160 to 161

    
              __NOTE__: When generating the key, please make sure you choose the key type as

              __RSA and RSA (default)__ and key size as __4096 bit__.

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md

    
                 a snippet of the Maven XML configuration block.  5. Insert this snippet

                 twice into your global Maven `settings.xml` file, typically

                 `${HOME}/.m2/settings.xml`. The end result should look like this, where

                 `TOKEN_NAME` and `TOKEN_PASSWORD` are your secret tokens:

Member Author

kennknowles Oct 6, 2023

Fixed

contributor-docs/release-guide.md Outdated

Comment on lines 707 to 708

    
              __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`).

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

Comment on lines 711 to 712

    
              __NOTE__: Make sure to include any breaking changes, even to `@Experimental`

              features, all major features and bug fixes, and all known issues.

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              For example, if an issue is found in the website pull request, just correct it on the spot and the vote can continue as-is.

              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

              "Stabilize the Release Branch" and address the problem.  However, some issues

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              versions to run all of the tests. See Python installation tips in [Developer

              Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-InstallingPythoninterpreters).

              > **Note** the community's validation means more than just running the tests

Member Author

kennknowles Oct 6, 2023

Done

contributor-docs/release-guide.md Outdated

    
              #### Run validations manually

              _Note_: -Prepourl and -Pver can be found in the RC vote email sent by Release Manager.

              > **Note** `-Prepourl` and `-Pver` can be found in the RC vote email sent by Release Manager.

Member Author

kennknowles Oct 6, 2023

Done

kennknowles force-pushed the release-guide branch from 3b26bca to a83590d Compare

October 6, 2023 18:25


          Update release guide somewhat according to 2.51.0 release experience

14950aa

kennknowles force-pushed the release-guide branch from a83590d to 14950aa Compare

October 6, 2023 18:31

kennknowles merged commit af9da31 into apache:master

4 checks passed

kennknowles deleted the release-guide branch

October 6, 2023 18:37

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet