Skip to content
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.

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

Post 2.50.0 Streamline release guide improvements #28287

Merged
merged 5 commits into from
Sep 8, 2023
Merged

Conversation

lostluck
Copy link
Contributor

@lostluck lostluck commented Sep 1, 2023

This is a larger cleanup of the release guide to clarify timings and positioning of the broader steps.

Larger emphasis has been put on the Release Manager's role prior to the release cut. If issues are addressed in the main branch before the cut, they do not need to be addressed afterwards. The release manager is empowered to do so.

Clarify some timing around the begining and end of the release by calling out the preparation steps should be performed within the week prior to the release cut. Also call out that release finalization tasks can be done within a few hours of the release being completed.

While the guide isn't materially shorter, maintaining the simpler structure as in the overview will make it less overwheling to release managers, since it's clearer when the various subtasks apply, vs the previous "13" steps. This should clarify the "build release candidate + vote + fix" loop that is the bulk of a release manager's tasks. I believe this will help get to release candidates sooner.

Add a new section "Post Release Tasks" which is where the Playground update task lives. While it's part of the release tasks, it doesn't block the release overall, so it felt weird structurally to have it as important as "Build a Release Candidate".

Various minor typos and fixes.

Rendered version should become available here:

http://apache-beam-website-pull-requests.storage.googleapis.com/28287/contribute/release-guide/index.html


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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

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

@lostluck
Copy link
Contributor Author

lostluck commented Sep 1, 2023

@github-actions
Copy link
Contributor

github-actions bot commented Sep 1, 2023

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

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
website/www/site/content/en/contribute/release-guide.md Outdated Show resolved Hide resolved
@lostluck
Copy link
Contributor Author

lostluck commented Sep 8, 2023

PTAL

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lostluck lostluck changed the title Post 2.50.0 Streamline release guide improvments Post 2.50.0 Streamline release guide improvements Sep 8, 2023
Copy link
Member

@kennknowles kennknowles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hate hate HATE markdown that is only readable when rendered (aka using a sequence of 1. 1. 1. 1.). But you didn't start the fire, for the most part...

@lostluck
Copy link
Contributor Author

lostluck commented Sep 8, 2023

I hate hate HATE markdown that is only readable when rendered (aka using a sequence of 1. 1. 1. 1.). But you didn't start the fire, for the most part...

I'm right there with you, but I'd make that a separate change across the whole file rather than adjust the untouched lists here, or only partially convert it.

@lostluck lostluck merged commit 03b5588 into master Sep 8, 2023
@lostluck lostluck deleted the improveRelease250 branch September 18, 2023 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants