damccorm commented on code in PR #29595: URL: https://github.com/apache/beam/pull/29595#discussion_r1415714271
########## contributor-docs/release-guide.md: ########## @@ -877,7 +877,8 @@ pull request, just correct it on the spot and the vote can continue as-is. ### Run validation tests The community is responsible for performing validation, but as release manager -you are expected to contribute as well. +you are expected to contribute as well. Please see the [RC Testing Guide](https://github.com/apache/beam/blob/master/contributor-docs/rc-testing-guide.md) Review Comment: We should add this link to the templated email as well instead of the link to the blog - https://github.com/apache/beam/blob/c9c89fe7d5f88b004635bd941725f6213c7d1cdc/contributor-docs/release-guide.md?plain=1#L836 (though ideally more prominently) ########## contributor-docs/rc-testing-guide.md: ########## @@ -0,0 +1,60 @@ +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Release Candidate (RC) Testing Guide + +This guide is meant for anybody who is interested in testing Beam Release Candidates against downstream projects. Note +that one need not have any status on the Apache Beam project (eg. PMC Member, Committer) to vote; all are welcome. +Please subscribe to the [dev list](https://lists.apache.org/[email protected]), and vote on the RC Vote email thread. + + +## RC Testing Objectives + +The RC testing process aims to: + + - Test new release candidates against existing code bases utilizing Apache Beam, to ensure there are no unexpected behaviors downstream. + - Incorporate a breadth of perspectives (including validation on multiple SDKs and multiple runners), before releasing a new version. + - Allow Beam Contributors to dogfood their changes and verify that they work as intended. + + +## Beam Release process overview +- For a comprehensive overview on the Beam release process, please take a look at our [release guide](https://github.com/apache/beam/blob/master/contributor-docs/release-guide.md). +- Note that release candidate votes will be open for 72 hours after the voting email is sent. + + +## Ideas for Python SDK Validators + +_Note: Do the following in a dev-like environment._ +- If you are a Python SDK user that utilizes notebooks (eg. Jupyter Notebooks, or Colab Notebooks), change `pip install` +to point to the new RC (e.g. `pip install apache_beam[gcp]==2.52.0rc1`). Re-execute the workflow to ensure everything +works as intended. +- If your workflow utilizes [Dataflow Templates](https://github.com/GoogleCloudPlatform/DataflowTemplates), or another way of launching your job, modify your `requirements.txt` file, `setup.py` file, or `DockerFile` to point to the new Beam RC. +- _Tip_: Run your pipeline both against Direct Runner, and another runner of your choice by modifying your job's `PipelineOptions`. + + +## Ideas for Java SDK Validators +_Note: Do the following in a dev-like environment._ +- If you are a Java SDK user that utilizes Maven or Gradle in your workflow, in your `pom.xml` file, modify the `beam.version` to reflect the newest RC, and modify the `<url>` tag under `<repository>`, to point to the repository given in the vote email. [Example Changes](https://github.com/GoogleCloudPlatform/DataflowTemplates/pull/1090/files). + + +##Ideas for Go SDK Validators Review Comment: ```suggestion ## Ideas for Go SDK Validators ``` ########## contributor-docs/rc-testing-guide.md: ########## @@ -0,0 +1,60 @@ +<!-- +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +# Release Candidate (RC) Testing Guide + +This guide is meant for anybody who is interested in testing Beam Release Candidates against downstream projects. Note +that one need not have any status on the Apache Beam project (eg. PMC Member, Committer) to vote; all are welcome. +Please subscribe to the [dev list](https://lists.apache.org/[email protected]), and vote on the RC Vote email thread. + + +## RC Testing Objectives + +The RC testing process aims to: + + - Test new release candidates against existing code bases utilizing Apache Beam, to ensure there are no unexpected behaviors downstream. + - Incorporate a breadth of perspectives (including validation on multiple SDKs and multiple runners), before releasing a new version. + - Allow Beam Contributors to dogfood their changes and verify that they work as intended. + + +## Beam Release process overview +- For a comprehensive overview on the Beam release process, please take a look at our [release guide](https://github.com/apache/beam/blob/master/contributor-docs/release-guide.md). +- Note that release candidate votes will be open for 72 hours after the voting email is sent. + + +## Ideas for Python SDK Validators + +_Note: Do the following in a dev-like environment._ +- If you are a Python SDK user that utilizes notebooks (eg. Jupyter Notebooks, or Colab Notebooks), change `pip install` +to point to the new RC (e.g. `pip install apache_beam[gcp]==2.52.0rc1`). Re-execute the workflow to ensure everything +works as intended. +- If your workflow utilizes [Dataflow Templates](https://github.com/GoogleCloudPlatform/DataflowTemplates), or another way of launching your job, modify your `requirements.txt` file, `setup.py` file, or `DockerFile` to point to the new Beam RC. +- _Tip_: Run your pipeline both against Direct Runner, and another runner of your choice by modifying your job's `PipelineOptions`. + + +## Ideas for Java SDK Validators +_Note: Do the following in a dev-like environment._ +- If you are a Java SDK user that utilizes Maven or Gradle in your workflow, in your `pom.xml` file, modify the `beam.version` to reflect the newest RC, and modify the `<url>` tag under `<repository>`, to point to the repository given in the vote email. [Example Changes](https://github.com/GoogleCloudPlatform/DataflowTemplates/pull/1090/files). + + +##Ideas for Go SDK Validators +_Note: Do the following in a dev-like environment._ +- If you utilize the Go SDK, use `go-get` to use the desired RC, for example, `go get -d github.com/apache/beam/sdks/[email protected]` +- Utilize the `--environment_config`, to point to the new release, for example, `--environment_config=apache/beam_go_sdk:2.44.0rc1` Review Comment: I don't think we actually need the `environment_config` bit anymore. @riteshghorse could you confirm (as someone who consistently validates Go)? -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
