damccorm commented on code in PR #34548: URL: https://github.com/apache/beam/pull/34548#discussion_r2031308796
########## contributor-docs/release-guide.md: ########## @@ -823,262 +899,23 @@ Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-In > downstream tests. It also includes double checking that our human-language > instructions actually still correspond to the automation that we have built. -#### Run validations using run_rc_validation.sh - -**Script:** [run_rc_validation.sh](https://github.com/apache/beam/blob/master/release/src/main/scripts/run_rc_validation.sh) - -**Usage** - 1. First update required configurations listed in `RC_VALIDATE_CONFIGS` in - [script.config](https://github.com/apache/beam/blob/master/release/src/main/scripts/script.config) - 2. Then run - ``` - ./release/src/main/scripts/run_rc_validation.sh - ``` - -**Note:** running the validations requires the ability to do the following in your GCP account: start pipelines, -write to BigQuery, and create a cluster of machines for running containers (for x-lang validation). - -**Tasks included** - 1. Create a PR to trigger Python validation job, including - * Python quickstart in batch and streaming mode with direct runner and Dataflow runner. - * Python Mobile Games(UserScore, HourlyTeamScore) with direct runner and Dataflow runner. - 2. Run Python Streaming MobileGames, includes - * Start a new terminal to run Java Pubsub injector. - * Start a new terminal to run Python LeaderBoard with Direct Runner. - * Start a new terminal to run Python LeaderBoard with Dataflow Runner. - * Start a new terminal to run Python GameStats with Direct Runner. - * Start a new terminal to run Python GameStats with Dataflow Runner. - 3. Multi-language pipelines validation, includes - * Running the Python quickstart example using Python portable DirectRunner. This will start a new terminal for the Java expansion service. - * Running the Java quickstart example using Python portable DirectRunner. This will start new terminals for the Python expansion service and the job server. - * Start a new terminal to run Python multi-language Java kafka validation with Dataflow Runner. - * Start a new terminal to run Python multi-language Java sql validation with Dataflow Runner. - -* **Tasks you need to do manually**. - -- [ ] Check whether validations succeed by following console output instructions. -- [ ] Terminate streaming jobs and java injector. -- [ ] Run Java quickstart (wordcount) and mobile game examples with the staged artifacts. The easiest way to do this is by running the tests on GitHub Actions. - -- Other manual validation will follow, but this will at least validate that the staged artifacts can be used. +#### Run validation workflows + +- [ ] Java Quickstart Validation: https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_java_quickstart.yml +- [ ] Java Mobile Gaming RC Validation (~60min): https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_java_mobile_gaming.yml +- [ ] Python Mobile Gaming RC Validation (~90min): https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_python_mobile_gaming.yml + +### Checklist to proceed to the next phase + +- [ ] Rerun all the previous tests that need the released containers +- [ ] Validate that the staged artifacts can be used. * Go to https://github.com/apache/beam/actions/workflows/beam_PostRelease_NightlySnapshot.yml/. * Click "Run Workflow". * Set `RELEASE` to `2.xx.0`, and set `SNAPSHOT_URL` to point to the staged artifacts in Maven central (https://repository.apache.org/content/repositories/orgapachebeam-NNNN/). * Click "Build". -- [ ] Sign up [spreadsheet](https://s.apache.org/beam-release-validation). +- [ ] [Optional] Sign up [spreadsheet](https://s.apache.org/beam-release-validation). Review Comment: ```suggestion - [ ] Sign up [spreadsheet](https://s.apache.org/beam-release-validation). ``` I think this should still be an expectation ########## contributor-docs/release-guide.md: ########## @@ -80,6 +80,39 @@ no vote requirements, and no timing requirements. A committer must be identified to be the Release Manager. In practice, most often a committer both proposes to release and volunteers themselves as Release Manager. +Note: For any steps marked "Google Internal", please request assistance from +Googlers via the `dev@` mailing list. Review Comment: Could we make this less specific to Google? We're the only ones who need this right now, but in theory others could in the future, and I think it is a little more friendly/open to make it generic. ```suggestion Note: For any steps marked "<company> Internal", please request assistance from employees of that company via the `dev@` mailing list. This is best effort, and you should not block the release waiting on these steps. These steps are designed to help validate the release and allow owners to perform any runner-specific steps needed to release. ``` ########## contributor-docs/release-guide.md: ########## @@ -823,262 +899,23 @@ Wiki](https://cwiki.apache.org/confluence/display/BEAM/Python+Tips#PythonTips-In > downstream tests. It also includes double checking that our human-language > instructions actually still correspond to the automation that we have built. -#### Run validations using run_rc_validation.sh - -**Script:** [run_rc_validation.sh](https://github.com/apache/beam/blob/master/release/src/main/scripts/run_rc_validation.sh) - -**Usage** - 1. First update required configurations listed in `RC_VALIDATE_CONFIGS` in - [script.config](https://github.com/apache/beam/blob/master/release/src/main/scripts/script.config) - 2. Then run - ``` - ./release/src/main/scripts/run_rc_validation.sh - ``` - -**Note:** running the validations requires the ability to do the following in your GCP account: start pipelines, -write to BigQuery, and create a cluster of machines for running containers (for x-lang validation). - -**Tasks included** - 1. Create a PR to trigger Python validation job, including - * Python quickstart in batch and streaming mode with direct runner and Dataflow runner. - * Python Mobile Games(UserScore, HourlyTeamScore) with direct runner and Dataflow runner. - 2. Run Python Streaming MobileGames, includes - * Start a new terminal to run Java Pubsub injector. - * Start a new terminal to run Python LeaderBoard with Direct Runner. - * Start a new terminal to run Python LeaderBoard with Dataflow Runner. - * Start a new terminal to run Python GameStats with Direct Runner. - * Start a new terminal to run Python GameStats with Dataflow Runner. - 3. Multi-language pipelines validation, includes - * Running the Python quickstart example using Python portable DirectRunner. This will start a new terminal for the Java expansion service. - * Running the Java quickstart example using Python portable DirectRunner. This will start new terminals for the Python expansion service and the job server. - * Start a new terminal to run Python multi-language Java kafka validation with Dataflow Runner. - * Start a new terminal to run Python multi-language Java sql validation with Dataflow Runner. - -* **Tasks you need to do manually**. - -- [ ] Check whether validations succeed by following console output instructions. -- [ ] Terminate streaming jobs and java injector. -- [ ] Run Java quickstart (wordcount) and mobile game examples with the staged artifacts. The easiest way to do this is by running the tests on GitHub Actions. - -- Other manual validation will follow, but this will at least validate that the staged artifacts can be used. +#### Run validation workflows + +- [ ] Java Quickstart Validation: https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_java_quickstart.yml +- [ ] Java Mobile Gaming RC Validation (~60min): https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_java_mobile_gaming.yml +- [ ] Python Mobile Gaming RC Validation (~90min): https://github.com/apache/beam/blob/master/.github/workflows/run_rc_validation_python_mobile_gaming.yml Review Comment: Could we link to the workflows instead of the config files? ```suggestion - [ ] Java Quickstart Validation: https://github.com/apache/beam/actions/workflows/run_rc_validation_java_quickstart.yml - [ ] Java Mobile Gaming RC Validation (~60min): https://github.com/apache/beam/actions/workflows/run_rc_validation_java_mobile_gaming.yml - [ ] Python Mobile Gaming RC Validation (~90min): https://github.com/apache/beam/actions/workflows/run_rc_validation_python_mobile_gaming.yml ``` ########## contributor-docs/release-guide.md: ########## @@ -1148,6 +985,8 @@ 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. +Note: when API docs are not updated after 6 hours, you can create the infra ticket to ask for helps (e.g., https://issues.apache.org/jira/browse/INFRA-26708). Review Comment: Should we add the specific troubleshooting step you took here as well? https://issues.apache.org/jira/browse/INFRA-26708 If it continues to cause pain we could automate this -- 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: github-unsubscr...@beam.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
