{{< toc >}}
The Apache Beam project periodically declares and publishes releases. A release is one or more packages of the project artifact(s) that are approved for general public distribution and use. They may come with various degrees of caveat regarding their perceived quality and potential for change, such as “alpha”, “beta”, “incubating”, “stable”, etc.
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. Any changes to this process should be discussed and adopted on the dev@ mailing list.
Please remember that publishing software has legal consequences. This guide complements the foundation-wide Product Release Policy and Release Distribution Policy.
The release process consists of several steps:
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@ mailing list, giving a solid argument and nominating a committer as the Release Manager (including themselves). There’s no formal process, no vote requirements, and no timing requirements. Any objections should be resolved by consensus before starting the release.
In general, the community prefers to have a rotating set of 3-5 Release Managers. Keeping a small core set of managers allows enough people to build expertise in this area and improve processes over time, without Release Managers needing to re-learn the processes for each release. That said, if you are a committer interested in serving the community in this way, please reach out to the community on the dev@ mailing list.
Before your first release, you should perform one-time configuration steps. This will set up your security keys for signing the release and access to various release repositories.
To prepare for each release, you should audit the project status in the JIRA issue tracker, and do necessary bookkeeping. Finally, you should create a release branch from which individual release candidates will be built.
NOTE: If you are using GitHub two-factor authentication and haven't configure HTTPS access, please follow the guide to configure command line access.
Please have these credentials ready at hand, you will likely need to enter them multiple times:
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, please create one according to the guidelines.
There are 2 ways to configure your GPG key for release, either using release automation script(which is recommended), or running all commands manually.
Script: preparation_before_release.sh
Usage
./beam/release/src/main/scripts/preparation_before_release.sh
Tasks included
Help you create a new GPG key if you want.
Configure git user.signingkey with chosen pubkey.
Add chosen pubkey into dev KEYS and release KEYS
NOTES: Only PMC can write into release repo.
Start GPG agents.
NOTE: When generating the key, please make sure you choose the key type as RSA and RSA (default) and key size as 4096 bit.
preparation_before_release.sh.You 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 2048R/845E6689 2016-02-23 uid Nomen Nescio <anonymous@apache.org> sub 2048R/BA4D50BE 2016-02-23
Here, the key ID is the 8-digit hex string in the pub line: 845E6689.
Configure access to the Apache Nexus repository, which enables final deployment of releases to the Maven Central Repository.
You 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>
In order to make yourself have right permission to stage java artifacts in Apache Nexus staging repository, please submit your GPG public key into MIT PGP Public Key Server.
If MIT doesn‘t work for you (it probably won’t, it's slow, returns 502 a lot, Nexus might error out not being able to find the keys), use a keyserver at ubuntu.com instead: https://keyserver.ubuntu.com/.
Updating the Beam website requires submitting PRs to both the main apache/beam repo and the apache/beam-site repo. The first contains reference manuals generated from SDK code, while the second updates the current release version number.
You should already have setup a local clone of apache/beam. Setting up a clone of apache/beam-site is similar:
$ git clone -b release-docs https://github.com/apache/beam-site.git $ cd beam-site $ git remote add <GitHub_user> git@github.com:<GitHub_user>/beam-site.git $ git fetch --all $ git checkout -b <my-branch> origin/release-docs
Further instructions on website development on apache/beam is here. Background information about how the website is updated can be found in Beam-Site Automation Reliability.
Release manager needs to have an account with PyPI. If you need one, register at PyPI. You also need to be a maintainer (or an owner) of the apache-beam package in order to push a new release. Ask on the mailing list for assistance.
Run following command manually. It will ask you to input your DockerHub ID and password if authorization info cannot be found from ~/.docker/config.json file.
docker login docker.io
After successful login, authorization info will be stored at ~/.docker/config.json file. For example,
"https://index.docker.io/v1/": {
"auth": "xxxxxx"
}
Release managers should have push permission; request membership in the beammaintainers team by filing a JIRA with the Apache Infrastructure team, like INFRA-20900.
When contributors resolve an issue in JIRA, 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:
Attention: Only PMC has permission to perform this. If you are not a PMC, please ask for help in dev@ mailing list.
Beam > Administration > Versions.Start Date, and choose Add.... menu and choose Release.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 JIRA issues for each regression with the ‘Fix Version’ set to the to-be-released version. The release manager oversees these just like any other JIRA issue marked with the ‘Fix Version’ of the release.
The mailing list should be informed to allow fixing the regressions in the course of the release.
Attention: Only committer has permission to create release branch in apache/beam.
Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the Apache code repository, and update version information on the original branch. The final state of the repository should match this diagram:
The key points to know:
master branch has the SNAPSHOT/dev version incremented.This will all be accomplished by the cut_release_branch.sh script.
After cutting the branch, you should manually update CHANGES.md on master by adding a new section for the next release.
Script: cut_release_branch.sh
Usage
# Cut a release branch
./beam/release/src/main/scripts/cut_release_branch.sh \
--release=${RELEASE_VERSION} \
--next_release=${NEXT_VERSION}
# Show help page
./beam/release/src/main/scripts/cut_release_branch.sh -h
Start a build of the nightly snapshot against master branch. Some processes, including our archetype tests, rely on having a live SNAPSHOT of the current version from the master branch. Once the release branch is cut, these SNAPSHOT versions are no longer found, so builds will be broken until a new snapshot is available.
There are 2 ways to trigger a nightly build, either using automation script(recommended), or perform all operations manually.
Script: start_snapshot_build.sh
Usage
./beam/release/src/main/scripts/start_snapshot_build.sh
The script will:
${your remote beam repo}/snapshot_buildTasks you need to do manually to verify the SNAPSHOT build
Run Gradle Publish into the generated PR.Run Gradle Publish in this pull request to trigger build.After the release branch is cut you need to make sure it builds and has no significant issues that would block the creation of the release candidate. There are 2 ways to perform this verification, either running automation script(recommended), or running all commands manually.
! Dataflow tests will fail if Dataflow worker container is not created and published by this time. (Should be done by Google)
Script: verify_release_build.sh
Usage
RELEASE_BUILD_CONFIGS in script.configcd beam/release/src/main/scripts && ./verify_release_build.sh
beam_Release_Gradle_Build and all PostCommit Jenkins jobs from PR (which is created by previous step). You can run mass_comment.py to do that. Or manually add one trigger phrase per PR comment. See COMMENTS_TO_ADD in mass_comment.py for full list of phrases.Tasks included in the script
hub with your agreement and setup local git repo;The beam_Release_Gradle_Build Jenkins job runs ./gradlew build -PisRelease. This only verifies that everything builds with unit tests passing.
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.
Pre-installation for python build
Install pip
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py python get-pip.py
Install virtualenv
pip install --upgrade virtualenv
Cython
sudo pip install cython sudo apt-get install gcc sudo apt-get install python-dev sudo apt-get install python3-dev sudo apt-get install python3.5-dev sudo apt-get install python3.6-dev sudo apt-get install python3.7-dev
Run gradle release build
Clean current workspace
git clean -fdx ./gradlew clean
Unlock the secret key
gpg --output ~/doc.sig --sign ~/.bashrc
Run build command
./gradlew build -PisRelease --no-parallel --scan --stacktrace --continue
To speed things up locally you might want to omit --no-parallel. You can also omit --continue if you want build fails after the first error instead of continuing, it may be easier and faster to find environment issues this way without having to wait until the full build completes.
The verify_release_build.sh script may include failing or flaky tests. For each of the failing tests create a JIRA 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: Major
Component: “test-failures”
Fix Version: Release number of verified release branch
Description: Description of failure
The dev@beam.apache.org 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.
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 Fix version field 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 version status page. Triage each unresolved issue with one of the following resolutions:
For all JIRA issues:
For JIRA issues with type “Bug” or labeled “flaky”:
Fix Version field to the version of the next release. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate.For all other JIRA issues:
Fix Version field to the new version you just created. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate.If there is a bug found in the RC creation process/tools, those issues should be considered high priority and fixed in 7 days.
Check if there are outstanding cherry-picks into the release branch, e.g. for 2.14.0. Make sure they have blocker JIRAs attached and are OK to get into the release by checking with community if needed.
As the Release Manager you are empowered to accept or reject cherry-picks to the release branch. 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.
dist.apache.org;git configuration;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).The core of the release process is the build-vote-fix cycle. Each cycle produces one release candidate. The Release Manager repeats this cycle until the community approves one release candidate, which is then finalized.
For this step, we recommend you using automation script to create a RC, but you still can perform all steps manually if you want.
Release candidates are built from single commits off the release branch. Before building, the version must be set to a non-SNAPSHOT, non-dev version. The final state of the repository should match this diagram:
Script: choose_rc_commit.sh
Usage
./beam/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.
Script: build_release_candidate.sh
Usage
./beam/release/src/main/scripts/build_release_candidate.sh
The script will:
${ver} with each supported Python version X.Y.docker run -it --entrypoint=/bin/bash apache/beam_python${ver}_sdk:${RELEASE}_rc{RC_NUM}
ls -al /opt/apache/beam/third_party_licenses/ | wc -l
docker run -it --entrypoint=/bin/bash apache/beam_java${ver}_sdk:${RELEASE}_rc{RC_NUM}
ls -al /opt/apache/beam/third_party_licenses/ | wc -l
orgapachebeam-NNNN.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.The build with -PisRelease creates the combined Javadoc for the release in sdks/java/javadoc.
The file sdks/java/javadoc/build.gradle contains a list of modules to include and exclude, plus a list of offline URLs that populate links from Beam's Javadoc to the Javadoc for other modules that Beam depends on.
Confirm that new modules added since the last release have been added to the inclusion list as appropriate.
Confirm that the excluded package list is up to date.
Verify the version numbers for offline links match the versions used by Beam. If the version number has changed, download a new version of the corresponding <module>-docs/package-list file.
Make sure you have tox installed:
pip install tox
Create the Python SDK documentation using sphinx by running a helper script.
cd sdks/python && pip install -r build-requirements.txt && tox -e py37-docs
By default the Pydoc is generated in sdks/python/target/docs/_build. Let ${PYDOC_ROOT} be the absolute path to _build.
Beam 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.
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 build_release_candidate.sh (see above).
PR 2: apache/beam
This pull request is against the apache/beam repo, on the master branch (example).
website/www/site/config.toml.website/www/site/content/en/get-started/downloads.md.website/www/site/static/.htaccess to redirect to the new version.Use the template below to write a blog post for the release. See beam-2.23.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 log --pretty='%aN' ^v2.10.0 v2.11.0 | 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:
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]({$JIRA_RELEASE_NOTES}).
## Highlights
* New highly anticipated feature X added to Python SDK ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
* New highly anticipated feature Y added to Java SDK ([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y)).
{$TOPICS e.g.:}
### I/Os
* Support for X source added (Java) ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
{$TOPICS}
### New Features / Improvements
* X feature added (Python) ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
* Y feature added (Java) [BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y).
### Breaking Changes
* X behavior was changed ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
* Y behavior was changed ([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y)).
### Deprecations
* X behavior is deprecated and will be removed in X versions ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
### Bugfixes
* Fixed X (Python) ([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-X)).
* Fixed Y (Java) ([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y)).
### Known Issues
* {$KNOWN_ISSUE_1}
* {$KNOWN_ISSUE_2}
* See a full list of open [issues that affect](https://issues.apache.org/jira/issues/?jql=project%20%3D%20BEAM%20AND%20affectedVersion%20%3D%20{$RELEASE}%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC) this version.
## List of Contributors
According to git shortlog, the following people contributed to the {$RELEASE_VERSION} release. Thank you to all contributors!
${CONTRIBUTORS}
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.zip.asc apache-beam-1.2.3-python.zip)grep for legal headers in each file.docker pull {image_name}
docker pull apache/beam_python3.5_sdk:2.16.0_rc1
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. The complete staging area is available for your review, which includes: * JIRA 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 [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], publishing the API reference manual [7], and the blog post [8]. * Java artifacts were built with Maven MAVEN_VERSION and OpenJDK/Oracle JDK JDK_VERSION. * Python artifacts are deployed along with the source release to the dist.apache.org [2]. * Validation sheet with a tab for 1.2.3 release to help with validation [9]. * Docker images published to Docker Hub [10]. The vote will be open for at least 72 hours. It is adopted by majority approval, with at least 3 PMC affirmative votes. Thanks, Release Manager [1] https://jira.apache.org/jira/secure/ReleaseNote.jspa?projectId=... [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://github.com/apache/beam/pull/... [9] https://docs.google.com/spreadsheets/d/1qk-N5vjXvbcEk68GjbkSZTR8AGqyNUM-oLFo_ZXBpJw/edit#gid=... [10] https://hub.docker.com/search?q=apache%2Fbeam&type=image
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. Proceed to the Fix Issues step below 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.
All tests listed in this spreadsheet
Since there are a bunch of tests, we recommend you running validations using automation script. In case of script failure, you can still run all of them manually.
Script: run_rc_validation.sh
Usage
RC_VALIDATE_CONFIGS in script.config./beam/release/src/main/scripts/run_rc_validation.sh
Tasks included
Tasks you need to do manually
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.10:runQuickstartJavaFlinkLocal \
-Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \
-Pver=${RELEASE_VERSION}
Spark Local Runner
./gradlew :runners:spark:2: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.zip.sha512 sha512sum -c apache-beam-2.5.0-source-release.zip.sha512
Build SDK
sudo apt-get install unzip unzip apache-beam-2.5.0-source-release.zip python setup.py sdist
Setup virtualenv
pip install --upgrade pip pip install --upgrade setuptools pip install --upgrade virtualenv virtualenv beam_env . beam_env/bin/activate
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:
Any issues identified during the community review and vote should be fixed in this step. Additionally, any JIRA issues created from the initial branch verification should be fixed.
Code changes should be proposed as standard pull requests to the master branch and reviewed using the normal contributing process. Then, relevant changes should be cherry-picked into the release branch proposed as pull requests against the release branch, again reviewed and merged using the normal contributing process.
Once all issues have been resolved, you should go back and build a new release candidate with these changes.
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!
Fix-Version for the current release should be closed.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.
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.
NOTE: If you are using GitHub two-factor authentication and haven't configure HTTPS access, please follow the guide to configure command line access.
./beam/release/src/main/scripts/deploy_pypi.sh
./beam/release/src/main/scripts/publish_docker_images.sh
(Optional) Clean up any unneeded local images afterward to save disk space.
Merge all of the website pull requests
Create and push a new signed tag for the released version by copying the tag for the final release candidate, as follows:
VERSION_TAG="v${RELEASE}"
git tag -s "$VERSION_TAG" "$RC_TAG"
git push https://github.com/apache/beam "$VERSION_TAG"
After pushing the tag, the tag should be visible on Github's Tags page.
Once the tag is uploaded, publish the release notes to Github, as follows:
cd beam/release/src/main/scripts && ./publish_github_release_notes.sh
Note this script reads the release notes from the blog post, so you should make sure to run this from master after merging the blog post PR.
After running the script, the release notes should be visible on Github's Releases page.
There are a few release finalization tasks that only PMC members have permissions to do. Ping dev@ for assistance if you need it.
Copy the source release from the dev repository to the release repository at dist.apache.org using Subversion.
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. The release manager should also make sure to update these links on the website (example).
In JIRA, inside version management, hover over the current release and a settings menu will appear. Click Release, and select today’s date.
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.
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!