The Beam community treats releases with great importance. They are a public face of the project and most users interact with the project only through the releases. Releases are signed off by the entire Beam community in a public vote.
Each release is executed by a Release Manager, who is selected among the Beam committers. This document describes the process that the Release Manager follows to perform a release.
Please remember that publishing software has legal consequences. This guide complements the foundation-wide guides:
A Beam release consists of the following:
In addition, each release is accompanied by:
The release process consists of several phases:
The following steps take place before the release branch is cut.
Deciding to release and selecting a Release Manager is the first step of the release process. This is a consensus-based decision of the entire community. Anybody can propose a release on the dev@
list. There is no formal process, 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.
When contributors resolve an issue in GitHub, they are tagging it with a release that will contain their changes. With the release currently underway, new issues should be resolved against a subsequent future release. Therefore, you should create a release item for this subsequent release, as follows:
In GitHub, navigate to Issues > Milestones > New Milestone
and add a new release for the next minor version after the version you are preparing to release.
Before your first release, you need to make sure you have all the necessary accounts, keys, and access for publishing the release. The release process also requires a variety of API tokens, which you can generate now or later when they are needed.
These are the credentials you will need:
This is your Apache committer user name and password. You selected these when you became an Apache Beam Committer.
repo
and workflow
permissions. They can be generated from this page: https://github.com/settings/tokens. See https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens for details.You need to have a GPG key to sign the release artifacts. Please be aware of the ASF-wide release signing guidelines. If you don’t have a GPG key associated with your Apache account, you must now create one according to the guidelines.
Run the following helper script, or you can open it and run the commands individually (helpful if it doesn't work as intended or if you already are partially set up)
./release/src/main/scripts/preparation_before_release.sh
NOTE: When generating the key, please make sure you choose the key type as RSA and RSA (default) and key size as 4096 bit.
Now you should have:
user.signingkey
set in your .gitconfig
gpg-agent
with the key loadedYou may need your Key ID for future steps. Determine your Apache GPG Key and Key ID as follows:
gpg --list-sigs --keyid-format LONG
This will list your GPG keys. One of these should reflect your Apache account, for example:
-------------------------------------------------- pub rsa4096/845E6689845E6689 2016-02-23 uid Nomen Nescio <anonymous@apache.org> sub rsa4096/BA4D50BEBA4D50BE 2016-02-23
Here, the key ID is the 16-digit hex string in the pub
line: 845E6689845E6689
.
In order to make yourself have right permission to stage java artifacts in Apache Nexus staging repository, please submit your GPG public key into the Ubuntu OpenPGP Key Server.
You will need to use an ascii-armored version of your key. This can be obtained by running:
gpg --export --armor
Copying the whole block including -----START PGP PUBLIC KEY BLOCK-----
and -----END PGP PUBLIC KEY BLOCK-----
Configure access to the Apache Nexus repository, which enables final deployment of releases to the Maven Central Repository.
Log in with your Apache account.
Confirm you have appropriate access by finding org.apache.beam
under Staging Profiles
.
Navigate to your Profile
(top right dropdown menu of the page).
Choose User Token
from the dropdown, then click Access User Token
. Copy a snippet of the Maven XML configuration block.
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:
<!-- make sure you have the root `settings node: --> <settings> <servers> <server> <id>apache.releases.https</id> <username>TOKEN_NAME</username> <password>TOKEN_PASSWORD</password> </server> <server> <id>apache.snapshots.https</id> <username>TOKEN_NAME</username> <password>TOKEN_PASSWORD</password> </server> </servers> </settings>
Each language has routine dependency maintenance that you should check now.
The Python base container images have pinned requirements.txt
that are compatible with our dependency constraints, and design to avoid run-time installs, since run-time installs cause large delays at start-up time. Ideally, we this should happen regularly when dependencies update, but it is important to ensure that they are fully up to date for each release.
Follow the instructions at https://s.apache.org/beam-python-requirements-generate
Go makes security patch releases of their tooling. This potentially affects container bootloader security, and at the least can cause false positives when an default-configuration scanner is pointed at our containers. Ideally, we upgrade as soon as possible, but it is also good to ensure we are up to date for each release.
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
Note Wait until the proposed branch cut day!
We cut the release branch on time and do not block/delay branch cut for incoming fixes. This is because bugs are always being introduced as part of normal development. We cut the branch to prevent new bugs being introduced and then we fix and cherrypick any truly release-blocking problems.
run workflow
)The final state of the repository after release branch is cut should match this diagram:
This should be accomplished by the cut_release_branch workflow.
The following must be manually done or confirmed:
master
branch has the SNAPSHOT/dev version incremented.CHANGES.md
on master
by adding a new section for the next release (example).The dev@ mailing list should be informed about the release branch being cut. Alongside with this note, a list of pending issues and to-be-triaged issues should be included. Afterwards, this list can be refined and updated by the release manager and the Beam community.
master
branch is moved along to the next release.dev@beam.apache.org
that you have cut the branch and are proceeding to stabilizationOnce the release branch is cut, your job is to make sure tests pass, fix bugs, confirm performance, defer feature requests, etc, until the branch is ready for the work of building a release candidate.
After the release branch is cut, make sure it builds and has no significant issues that would block the creation of the release candidate.
NOTE Dataflow tests will fail if the Dataflow worker container is not created and published by this time. Should be done by Google, in response to the creation of the release branch, and docker images are hosted. This should not block creation of the first release candidate, but should block approval of the release.
Script: verify_release_build.sh
Usage
repo
and workflow
permissions for this token.RELEASE_BUILD_CONFIGS
in script.config(cd release/src/main/scripts && ./verify_release_build.sh)
release/trigger_all_tests.json
), so no additional action should be needed.Tasks included in the script
hub
with your agreement and setup local git repo;There are some projects that don't produce the artifacts, e.g. beam-test-tools
, you may be able to ignore failures there.
To triage the failures and narrow things down you may want to look at settings.gradle.kts
and run the build only for the projects you're interested at the moment, e.g. ./gradlew :runners:java-fn-execution
.
The verify_release_build.sh
script may include failing or flaky tests. For each of the failing tests create a GitHub Issue with the following properties:
Issue Type: Bug
Summary: Name of failing gradle task and name of failing test (where applicable) in form of :MyGradleProject:SomeGradleTask NameOfFailedTest: Short description of failure
Priority: P1
Component: “test-failures”
Milestone: Release number of verified release branch
Description: Description of failure
Check the Beam load tests for possible performance regressions. Measurements are available on metrics.beam.apache.org.
All Runners which publish data should be checked for the following, in both batch and streaming mode:
If regressions are found, the release branch can still be created, but the regressions should be investigated and fixed as part of the release process. The role of the release manager is to file GitHub issues for each regression with the milestone set to the to-be-released version. The release manager oversees these just like any other issue marked with the milestone of the release.
The mailing list should be informed to allow fixing the regressions in the course of the release. Issues should be filed and tagged with the milestone.
There could be outstanding release-blocking issues, which should be triaged before proceeding to build a release candidate. We track them by assigning the blocked release to the issue's milestone before the issue is resolved.
The release manager should triage what does and does not block a release. The list of release-blocking issues is available at the milestone status page. Triage each unresolved issue with one of the following resolutions:
For all GitHub issues:
For issues with type “Bug” or labeled “flaky”:
For all other GitHub issues:
If there is a bug found in the RC creation process/tools, those issues should be considered high priority and fixed in 7 days.
The release manager is empowered to triage issues, and accept or reject cherry-picks to the release branch. Cherry picks are necessary if there are outstanding issues at time of the release branch cut, or issues were found in verification.
Check if there are outstanding cherry-picks into the release branch, e.g. for 2.14.0
. Make sure they have blocker Issues attached and are OK to get into the release by checking with community if needed.
You are encouraged to ask the following questions to be answered on each cherry-pick PR and you can choose to reject cherry-pick requests if these questions are not satisfactorily answered:
It is important to accept major/blocking fixes to isolated issues to make a higher quality release. However, beyond that each cherry pick will increase the time required for the release and add more last minute code to the release branch. Neither late releases nor not fully tested code will provide positive user value.
Tip: Another tool in your toolbox is the known issues section of the release blog. Consider adding known issues there for minor issues instead of accepting cherry picks to the release branch.
From the release branch, building a candidate involves selecting a commit, tagging that commit, and building the various artifacts against that commit. You can also run verifications against the RC commit (verification will also occur during voting phase).
dist.apache.org
.git
configuration.SIGNING_KEY
to the public key of the Manager's GPG key.org.apache.beam
listed under Staging Profiles
in Nexus.settings.xml
.JAVA_HOME
to JDK 8 (Example: export JAVA_HOME=/example/path/to/java/jdk8
).Release candidates are built from single tagged commits off the release branch. When you have identified a good commit on the release branch, run choose_rc_commit.sh to set it up correctly.
./release/src/main/scripts/choose_rc_commit.sh \ --release "${RELEASE_VERSION}" \ --rc "${RC_NUM}" \ --commit "${COMMIT_REF}" \ --clone \ --push-tag
You can do a dry run by omitting the --push-tag
flag. Then it will only clone the repo, adjust the version, and add the tag locally. If it looks good, run it again with --push-tag
. If you already have a clone that includes the ${COMMIT_REF}
then you can omit --clone
. This is perfectly safe since the script does not depend on the current working tree.
See the source of the script for more details, or to run commands manually in case of a problem.
The final state of the repository after an RC commit is chosen should match this diagram:
The following should be confirmed:
Action build_release_candidate (click run workflow
)
The action will:
At https://hub.docker.com/u/apache, visit each repository and navigate to “tags” tab. Verify images are pushed with tags: ${RELEASE_VERSION}rc${RC_NUM}
Verify that third party licenses are included in Docker. You can do this with a simple script:
RC_TAG=${RELEASE_VERSION}rc${RC_NUM} for pyver in 3.8 3.9 3.10 3.11; do docker run --rm --entrypoint sh \ apache/beam_python${pyver}_sdk:${RC_TAG} \ -c 'ls -al /opt/apache/beam/third_party_licenses/ | wc -l' done for javaver in 8 11 17; do docker run --rm --entrypoint sh \ apache/beam_java${javaver}_sdk:${RC_TAG} \ -c 'ls -al /opt/apache/beam/third_party_licenses/ | wc -l' done
And you may choose to log in to the containers and inspect:
docker run --rm -it --entrypoint=/bin/bash \ apache/beam_java${ver}_sdk:${RC_TAG} ls -al /opt/apache/beam/third_party_licenses/
orgapachebeam-NNNN
.https://repository.apache.org/content/repositories/orgapachebeam-NNNN/
. They should contain all relevant parts for each module, including pom.xml
, jar, test jar, javadoc, etc. Artifact names should follow the existing format in which artifact name mirrors directory structure, e.g., beam-sdks-java-io-kafka
. Carefully review any new artifacts. Some additional validation should be done during the rc validation step.rc
artifacts to PyPIThis step uploads artifacts such as apache-beam-${RELEASE_VERSION}rc${RC_NUM}
to PyPI, so the RC artifacts can be depended upon directly by consumers, for ease of RC verification.
Action deploy_release_candidate_pypi (click run workflow
)
The Action will:
Download previously build python binary artifacts Deploy release candidate to PyPI with an rc
suffix.
Attention: Verify that:
rc-#
suffixBeam publishes API reference manuals for each release on the website. For Java and Python SDKs, that’s Javadoc and PyDoc, respectively. The final step of building the candidate is to propose website pull requests that update these manuals. The first pr will get created by the build_release_candidate action, you will need to create the second one manually
Merge the pull requests only after finalizing the release. To avoid invalid redirects for the ‘current’ version, merge these PRs in the order listed. Once the PR is merged, the new contents will get picked up automatically and served to the Beam website, usually within an hour. A committer can manually trigger the beam_PostCommit_Website_Publish task in Jenkins to avoid waiting.
PR 1: apache/beam-site
This pull request is against the apache/beam-site
repo, on the release-docs
branch (example). It is created by the build_release_candidate
workflow (see above).
PR 2: apache/beam
This pull request is against the apache/beam
repo, on the master
branch (example).
CHANGES.md
to update release date and remove template.website/www/site/config.toml
.website/www/site/content/en/get-started/downloads.md
.Use the template below to write a blog post for the release. See beam-2.31.0.md as an example.
CHANGES.md
to the blog post and edit as necessary.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
). Make sure to clean it up, as there may be duplicate or incorrect user names.
NOTE Make sure to include any breaking changes, even to
@Experimental
features, all major features and bug fixes, and all known issues.
Template:
--- title: "Apache Beam {$RELEASE_VERSION}" date: YYYY-MM-DD H:MM:00 Z categories: - blog - release authors: - {$RELEASE_MANAGER} --- <!-- 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. --> We are happy to present the new {$RELEASE_VERSION} release of Beam. This release includes both improvements and new functionality. See the [download page](/get-started/downloads/{$DOWNLOAD_ANCHOR}) for this release. <{$REMOVE_FOR_VALID_SUMMARY_BREAK}!--more--> For more information on changes in {$RELEASE_VERSION}, check out the [detailed release notes]({$LINK_TO_GITHUB_MILESTONE}). ## Highlights * New highly anticipated feature X added to Python SDK ([#X](https://github.com/apache/beam/issues/X)). * New highly anticipated feature Y added to Java SDK ([#Y](https://github.com/apache/beam/issues/Y)). {$TOPICS e.g.:} ### I/Os * Support for X source added (Java) ([#X](https://github.com/apache/beam/issues/X)). {$TOPICS} ### New Features / Improvements * X feature added (Python) ([#X](https://github.com/apache/beam/issues/X)). * Y feature added (Java) [#Y](https://github.com/apache/beam/issues/Y). ### Breaking Changes * X behavior was changed ([#X](https://github.com/apache/beam/issues/X)). * Y behavior was changed ([#Y](https://github.com/apache/beam/issues/Y)). ### Deprecations * X behavior is deprecated and will be removed in X versions ([#X](https://github.com/apache/beam/issues/X)). ### Bugfixes * Fixed X (Python) ([#X](https://github.com/apache/beam/issues/X)). * Fixed Y (Java) ([#Y](https://github.com/apache/beam/issues/Y)). ### Known Issues * {$KNOWN_ISSUE_1} * {$KNOWN_ISSUE_2} For the most up to date list of known issues, see https://github.com/apache/beam/blob/master/CHANGES.md ## List of Contributors According to git shortlog, the following people contributed to the {$RELEASE_VERSION} release. Thank you to all contributors! ${CONTRIBUTORS}
{RELEASE_VERSION}rc{RC_NUM}
.You can (optionally) also do additional verification by:
README.md
, NOTICE
, and LICENSE
files.md5sum -c *.md5
and sha1sum -c *.sha1
. Note that signature/checksum files of Java artifacts may not contain filenames. Hence you might need to compare checksums/signatures manually or modify the files by appending the filenames.)gpg --verify apache-beam-1.2.3-python.tar.gz.asc apache-beam-1.2.3-python.tar.gz
)grep
for legal headers in each file.docker pull apache/beam_python3.7_sdk:2.39.0rc1
Once you have built and individually reviewed the release candidate, please share it for the community-wide review. Please review foundation-wide voting guidelines for more information.
Start the review-and-vote thread on the dev@ mailing list. Here’s an email template; please adjust as you see fit.
From: Release Manager To: dev@beam.apache.org Subject: [VOTE] Release 1.2.3, release candidate #3 Hi everyone, Please review and vote on the release candidate #3 for the version 1.2.3, as follows: [ ] +1, Approve the release [ ] -1, Do not approve the release (please provide specific comments) Reviewers are encouraged to test their own use cases with the release candidate, and vote +1 if no issues are found. Only PMC member votes will count towards the final vote, but votes from all community members is encouraged and helpful for finding regressions; you can either test your own use cases [13] or use cases from the validation sheet [10]. The complete staging area is available for your review, which includes: * GitHub Release notes [1], * the official Apache source release to be deployed to dist.apache.org [2], which is signed with the key with fingerprint FFFFFFFF (D20316F712213422 if automated) [3], * all artifacts to be deployed to the Maven Central Repository [4], * source code tag "v1.2.3-RC3" [5], * website pull request listing the release [6], the blog post [6], and publishing the API reference manual [7]. * Python artifacts are deployed along with the source release to the dist.apache.org [2] and PyPI[8]. * Go artifacts and documentation are available at pkg.go.dev [9] * 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]. The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes. For guidelines on how to try the release in your projects, check out our RC testing guide [13]. Thanks, Release Manager [1] https://github.com/apache/beam/milestone/1... [2] https://dist.apache.org/repos/dist/dev/beam/1.2.3/ [3] https://dist.apache.org/repos/dist/release/beam/KEYS [4] https://repository.apache.org/content/repositories/orgapachebeam-NNNN/ [5] https://github.com/apache/beam/tree/v1.2.3-RC3 [6] https://github.com/apache/beam/pull/... [7] https://github.com/apache/beam-site/pull/... [8] https://pypi.org/project/apache-beam/1.2.3rc3/ [9] https://pkg.go.dev/github.com/apache/beam/sdks/v2@v1.2.3-RC3/go/pkg/beam [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
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 don’t require cancellation. 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.
The community is responsible for performing validation, but as release manager you are expected to contribute as well. Please see the RC Testing Guide for ideas on helping validate testing on downstream projects.
Before accepting an RC, as a community we try to exercise most (if not all) of the tests listed in this spreadsheet, and those are good validations for you to try out as release manager. The goal of these tests is to validate that we're able to run basic pipelines from a variety of environments (not just our CI environment).
Since there are many tests, we recommend you running some validations using an automation script. In case of script failure, you can still run all of them manually.
You may need to have Python interpreters for all supported Python minor versions to run all of the tests. See Python installation tips in Developer Wiki.
Note The community's validation means more than just running the tests that we have already run. It includes users trying out the RC on their own downstream tests. It also includes double checking that our human-language instructions actually still correspond to the automation that we have built.
Script: run_rc_validation.sh
Usage
RC_VALIDATE_CONFIGS
in script.config./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
[ ] 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.
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/).[ ] Sign up spreadsheet.
[ ] Vote in the release thread.
Note
-Prepourl
and-Pver
can be found in the RC vote email sent by Release Manager.
Java Quickstart Validation
Direct Runner
./gradlew :runners:direct-java:runQuickstartJavaDirect \ -Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \ -Pver=${RELEASE_VERSION}
Flink Local Runner
./gradlew :runners:flink:1.13:runQuickstartJavaFlinkLocal \ -Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \ -Pver=${RELEASE_VERSION}
Spark Local Runner
./gradlew :runners:spark:3:runQuickstartJavaSpark \ -Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \ -Pver=${RELEASE_VERSION}
Dataflow Runner
./gradlew :runners:google-cloud-dataflow-java:runQuickstartJavaDataflow \ -Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \ -Pver=${RELEASE_VERSION} \ -PgcpProject=${YOUR_GCP_PROJECT} \ -PgcsBucket=${YOUR_GCP_BUCKET}
Java Mobile Game(UserScore, HourlyTeamScore, Leaderboard)
Prerequisites
Create your own BigQuery dataset
bq mk --project_id=${YOUR_GCP_PROJECT} ${YOUR_DATASET}
Create your PubSub topic
gcloud alpha pubsub topics create --project=${YOUR_GCP_PROJECT} ${YOUR_PROJECT_PUBSUB_TOPIC}
Setup your service account
Goto IAM console in your project to create a service account as project owner
, then run
gcloud iam service-accounts keys create ${YOUR_KEY_JSON} --iam-account ${YOUR_SERVICE_ACCOUNT_NAME}@${YOUR_PROJECT_NAME} export GOOGLE_APPLICATION_CREDENTIALS=${PATH_TO_YOUR_KEY_JSON}
Run
./gradlew :runners:google-cloud-dataflow-java:runMobileGamingJavaDataflow \ -Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \ -Pver=${RELEASE_VERSION} \ -PgcpProject=${YOUR_GCP_PROJECT} \ -PgcsBucket=${YOUR_GCP_BUCKET} \ -PbqDataset=${YOUR_DATASET} -PpubsubTopic=${YOUR_PROJECT_PUBSUB_TOPIC}
Python Quickstart(batch & streaming), MobileGame(UserScore, HourlyTeamScore)
Create a new PR in apache/beam.
In comment area, type in Run Python ReleaseCandidate
to trigger validation.
Python Leaderboard & GameStats
Get staging RC wget https://dist.apache.org/repos/dist/dev/beam/2.5.0/*
Verify the hashes
sha512sum -c apache-beam-2.5.0-python.tar.gz.sha512 sha512sum -c apache-beam-2.5.0-source-release.tar.gz.sha512
Build SDK
sudo apt-get install unzip unzip apache-beam-2.5.0-source-release.tar.gz python setup.py sdist
Setup virtual environment
python3 -m venv beam_env . ./beam_env/bin/activate pip install --upgrade pip setuptools wheel
Install SDK
pip install dist/apache-beam-2.5.0.tar.gz pip install dist/apache-beam-2.5.0.tar.gz[gcp]
Setup GCP
Please repeat following steps for every following test.
bq rm -rf --project=${YOUR_PROJECT} ${USER}_test bq mk --project_id=${YOUR_PROJECT} ${USER}_test gsutil rm -rf ${YOUR_GS_STORAGE] gsutil mb -p ${YOUR_PROJECT} ${YOUR_GS_STORAGE} gcloud alpha pubsub topics create --project=${YOUR_PROJECT} ${YOUR_PUBSUB_TOPIC}
Setup your service account as described in Java Mobile Game
section above.
Produce data by using java injector:
Configure your ~/.m2/settings.xml as following:
<settings> <profiles> <profile> <id>release-repo</id> <activation> <activeByDefault>true</activeByDefault> </activation> <repositories> <repository> <id>Release 2.4.0 RC3</id> <name>Release 2.4.0 RC3</name> <url>https://repository.apache.org/content/repositories/orgapachebeam-1031/</url> </repository> </repositories> </profile> </profiles> </settings>
Note: You can found the latest id
, name
and url
for one RC in the vote email thread sent out by Release Manager.
Run
mvn archetype:generate \ -DarchetypeGroupId=org.apache.beam \ -DarchetypeArtifactId=beam-sdks-java-maven-archetypes-examples \ -DarchetypeVersion=${RELEASE_VERSION} \ -DgroupId=org.example \ -DartifactId=word-count-beam \ -Dversion="0.1" \ -Dpackage=org.apache.beam.examples \ -DinteractiveMode=false -DarchetypeCatalog=internal mvn compile exec:java -Dexec.mainClass=org.apache.beam.examples.complete.game.injector.Injector \ -Dexec.args="${YOUR_PROJECT} ${YOUR_PUBSUB_TOPIC} none"
Run Leaderboard with Direct Runner
python -m apache_beam.examples.complete.game.leader_board \ --project=${YOUR_PROJECT} \ --topic projects/${YOUR_PROJECT}/topics/${YOUR_PUBSUB_TOPIC} \ --dataset ${USER}_test
Inspect results:
Run Leaderboard with Dataflow Runner
python -m apache_beam.examples.complete.game.leader_board \ --project=${YOUR_PROJECT} \ --region=${GCE_REGION} \ --topic projects/${YOUR_PROJECT}/topics/${YOUR_PUBSUB_TOPIC} \ --dataset ${USER}_test \ --runner DataflowRunner \ --temp_location=${YOUR_GS_BUCKET}/temp/ \ --sdk_location dist/*
Inspect results:
Run GameStats with Direct Runner
python -m apache_beam.examples.complete.game.game_stats \ --project=${YOUR_PROJECT} \ --topic projects/${YOUR_PROJECT}/topics/${YOUR_PUBSUB_TOPIC} \ --dataset ${USER}_test \ --fixed_window_duration ${SOME_SMALL_DURATION}
Inspect results:
Run GameStats with Dataflow Runner
python -m apache_beam.examples.complete.game.game_stats \ --project=${YOUR_PROJECT} \ --region=${GCE_REGION} \ --topic projects/${YOUR_PROJECT}/topics/${YOUR_PUBSUB_TOPIC} \ --dataset ${USER}_test \ --runner DataflowRunner \ --temp_location=${YOUR_GS_BUCKET}/temp/ \ --sdk_location dist/* \ --fixed_window_duration ${SOME_SMALL_DURATION}
Inspect results:
Reply on the vote thread to close the voting once following conditions are met for the current release candidate.
Then, tally the votes in a separate email thread. Here’s an email template; please adjust as you see fit.
From: Release Manager To: dev@beam.apache.org Subject: [RESULT] [VOTE] Release 1.2.3, release candidate #3 I'm happy to announce that we have unanimously approved this release. There are XXX approving votes, XXX of which are binding: * approver 1 * approver 2 * approver 3 * approver 4 There are no disapproving votes. Thanks everyone!
Once the release candidate has been reviewed and approved by the community, the release should be finalized. This involves the final deployment of the release candidate to the release repositories, merging of the website changes, etc.
This does not take very long, and can be accomplished within hours of the vote being finalized.
Use the Apache Nexus repository manager to release the staged binary artifacts to the Maven Central repository. In the Staging Repositories
section, find the relevant release candidate orgapachebeam-XXX
entry and click Release
. Drop all other release candidates that are not being released.
After running the action, perform the following checks:
v{RELEASE_VERSION}
and sdks/v{RELEASE_VERSION}
tags should be visible on Github's Tags page.Merge all of the website pull requests
Once the tag is uploaded, publish the release notes to Github. From the Beam release page on Github select “Draft a new release.” Title the release “Beam ${RELEASE_VERSION} release” and set the release at the 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.
The release notes should now be visible on Github's Releases page.
In GitHub, in the milestone page, click close on the current release.
There are a few release finalization tasks that only PMC members have permissions to do. Ping dev@ mailing list for assistance if you need it.
Copy the source release from the dev
repository to the release
repository at dist.apache.org
using Subversion.
export RELEASE_VERSION=<set the release version> export OLD_RELEASE_VERSION=<set the previous release version> svn co https://dist.apache.org/repos/dist/dev/beam dev # Checkout the `dev` artifact repo. svn co https://dist.apache.org/repos/dist/release/beam release # Checkout the `release` artifact repo. mkdir release/$RELEASE_VERSION cp -R dev/$RELEASE_VERSION/* release/$RELEASE_VERSION/ cd release svn add $RELEASE_VERSION svn rm $OLD_RELEASE_VERSION # Delete all artifacts from old releases. svn commit -m "Adding artifacts for the ${RELEASE_VERSION} release and removing old artifacts"
Make sure the last release's artifacts have been copied from dist.apache.org
to archive.apache.org
. This should happen automatically: dev@ thread with context.
Use reporter.apache.org to seed the information about the release into future project reports.
Once the release has been finalized, the last step of the process is to promote the release within the project and beyond.
Announce on the dev@ mailing list that the release has been finished.
Announce on the release on the user@ mailing list, listing major improvements and contributions.
Announce the release on the announce@apache.org mailing list. NOTE: This can only be done from @apache.org
email address. This email has to be in plain text (no HTML tags).
Tweet, post on Facebook, LinkedIn, and other platforms. Ask other contributors to do the same.
Also, update the Wikipedia article on Apache Beam.
At the end of the release, go to the GitHub milestones page and mark the recently released version as closed.
Google releases a BOM that pins compatible versions of their Java libraries. After the release, try updating the BOM to the latest version.
To do so, create a draft PR and run test suites following the instructions at https://github.com/apache/beam/blob/master/contributor-docs/java-dependency-upgrades.md.
Triage the test failures and rerun any tests that seem potentially unrelated to the upgrade. If there are no test failures due to the BOM upgrade, request review and merge the PR as normal.
If there are test failures due to the BOM upgrade, email the dev list and ask for a volunteer to take the update forward. It is not your responsibility to fix the BOM issues or to find a volunteer (though you are welcome to take it forward). If nobody volunteers, that is OK and this issue can roll forward to the next release. You can optionally use the following template for your email to the dev list:
From: Release Manager To: dev@beam.apache.org Subject: Java BOM Update X.Y.Z Hi everyone, Following the instructions in https://github.com/apache/beam/blob/master/contributor-docs/release-guide.md#post-release-tasks I've attempted to update the Java Google BOM and have run into test issues caused by the upgrade [1]. Since the Java Google BOM update is best effort for a release manager, I'm handing this piece off to the community. If you would like to volunteer to help, you can get started by following the instructions in https://github.com/apache/beam/blob/master/contributor-docs/java-dependency-upgrades.md#google-cloud-related-dependency-upgrades otherwise this will roll over to the next release. Thanks, Release Manager [1] https://github.com/apache/beam/pull/123
After the new Beam release is published, the Java starter project needs to have its version manually upgraded. To do this, create a PR like https://github.com/apache/beam-starter-java/pull/94 (with the appropriate version number).
You can also update the versions in https://github.com/apache/beam-starter-python and https://github.com/apache/beam-starter-go if you would like. This is optional because dependabot will automatically open a PR to do this if you don't.
After new Beam Release is published, Beam Playground can be updated following the steps below:
It is important that we improve the release processes over time. Once you’ve finished the release, please take a step back and look what areas of this process and be improved. Perhaps some part of the process can be simplified. Perhaps parts of this guide can be clarified.
If we have specific ideas, please start a discussion on the dev@ mailing list and/or propose a pull request to update this guide. Thanks!
The above document assumes a minor version bump cut off of the master branch. If you want to do a patch release cut off of a previous release branch, use the following steps:
git clone https://github.com/apache/beam cd beam git fetch origin release-2.XX.0 git checkout release-2.XX.0 git checkout -b release-2.XX.1 git push origin release-2.XX.1