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]({{ site.baseurl }}/get-started/support/).
Please remember that publishing software has legal consequences. This guide complements the foundation-wide Product Release Policy and Release Distribution Policy.
{:width=“100%”}
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.
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.
Get more entropy for creating a GPG key
sudo apt-get install rng-tools sudo rngd -r /dev/urandom
Create a GPG key
gpg --full-generate-key
Determine your Apache GPG Key and Key ID, as follows:
gpg --list-keys
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.
Now, add your Apache GPG key to the Beam’s KEYS file both in dev and release repositories at dist.apache.org. Follow the instructions listed at the top of these files. (Note: Only PMC members have write access to the release repository. If you end up getting 403 errors ask on the mailing list for assistance.)
Configure git to use this key when signing code by giving it your key ID, as follows:
git config --global user.signingkey 845E6689
You may drop the --global option if you’d prefer to use this key for the current repository only.
Start GPG agent in order to unlock your GPG key
eval $(gpg-agent --daemon --no-grab --write-env-file $HOME/.gpg-agent-info) export GPG_TTY=$(tty) export GPG_AGENT_INFO
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:
<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.
Prepare to update the Beam website by following the [website development instructions]({{ site.baseurl }}/contribute/website-contributions/).
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.
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.There could be outstanding release-blocking issues, which should be triaged before proceeding to build a release candidate. We track them by assigning a specific Fix version field even before the issue resolved.
The list of release-blocking issues is available at the version status page. Triage each unresolved issue with one of the following resolutions:
Fix Version field to the new version you just created. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate.JIRA automatically generates Release Notes based on the Fix Version field applied to issues. Release Notes are intended for Beam users (not Beam committers/contributors). You should ensure that Release Notes are informative and useful.
Open the release notes from the version status page by choosing the release underway and clicking Release Notes.
You should verify that the issues listed automatically by JIRA are appropriate to appear in the Release Notes. Specifically, issues should:
Bug, New Feature, Improvement, etc.Adjust any of the above properties to the improve clarity and presentation of the Release Notes.
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.
There are 2 ways to cut a release branch: either running automation script(recommended), or running all commands manually.
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
Tasks included
Create release-${RELEASE_VERSION} branch locally.
Change and commit dev versoin number in master branch:
Change and commit version number in release branch:
Checkout working branch
Check out the version of the codebase from which you start the release. For a new minor or major release, this may be HEAD of the master branch. To build a hotfix/incremental release, instead of the master branch, use the release tag of the release being patched. (Please make sure your cloned repository is up-to-date before starting.)
git checkout <master branch OR release tag>
NOTE: If you are doing an incremental/hotfix release (e.g. 2.5.1), please check out the previous release tag, rather than the master branch.
Set up environment variables
Set up a few environment variables to simplify Maven commands that follow. (We use bash Unix syntax in this guide.)
RELEASE=2.5.0
NEXT_VERSION_IN_BASE_BRANCH=2.6.0
BRANCH=release-${RELEASE}
Version represents the release currently underway, while next version specifies the anticipated next version to be released from that branch. Normally, 1.2.0 is followed by 1.3.0, while 1.2.3 is followed by 1.2.4.
NOTE: Only if you are doing an incremental/hotfix release (e.g. 2.5.1), please check out the previous release tag, before running the following instructions:
BASE_RELEASE=2.5.0
RELEASE=2.5.1
NEXT_VERSION_IN_BASE_BRANCH=2.6.0
git checkout tags/${BASE_RELEASE}
Create release branch locally
git branch ${BRANCH}
Update version files in the master branch.
# Now change the version in existing gradle files, and Python files
sed -i -e "s/'${RELEASE}'/'${NEXT_VERSION_IN_BASE_BRANCH}'/g" build_rules.gradle
sed -i -e "s/${RELEASE}/${NEXT_VERSION_IN_BASE_BRANCH}/g" gradle.properties
sed -i -e "s/${RELEASE}/${NEXT_VERSION_IN_BASE_BRANCH}/g" sdks/python/apache_beam/version.py
# Save changes in master branch
git add gradle.properties build_rules.gradle sdks/python/apache_beam/version.py
git commit -m "Moving to ${NEXT_VERSION_IN_BASE_BRANCH}-SNAPSHOT on master branch."
Check out the release branch.
git checkout ${BRANCH}
Update version files in release branch
DEV=${RELEASE}.dev
sed -i -e "s/${DEV}/${RELEASE}/g" sdks/python/apache_beam/version.py
sed -i -e "s/'beam-master-.*'/'beam-${RELEASE}'/g" runners/google-cloud-dataflow-java/build.gradle
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
Tasks included
${your remote beam repo}/snapshot_buildTasks you need to do manually
Run Gradle Publish into the generated PR.Run Gradle Publish in this pull request to trigger build.There are 2 ways to perform this verification, either running automation script(recommended), or running all commands manually.
Script: verify_release_build.sh
Usage
./beam/release/src/main/scripts/verify_release_build.sh
Tasks included
pip, virtualenv, cython and /usr/bin/time with your agreements.gradle release build against release branch.Tasks you need to do manually
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
Make sure your time alias to /usr/bin/time, if not:
sudo apt-get install time alias time='/usr/bin/time'
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
The build with -PisRelease creates the combined Javadoc for the release in sdks/java/javadoc.
The file sdks/java/javadoc/ant.xml file contains a list of modules to include in 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.
dist.apache.orggit configurationorg.apache.beam listed under Staging Profiles in Nexussettings.xmlThe 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.
BUT the final step of rc creation is Build and stage python wheels, which need to done manually.
Script: build_release_candidate.sh
Usage
./beam/release/src/main/scripts/build_release_candidate.sh
Tasks included
Run gradle release to create rc tag and push source release into github repo.
Run gradle publish to push java artifacts into Maven staging repo.
NOTE: In order to public staging artifacts, you need to goto the staging repo to close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Beam, version X, release candidate Y”.
Stage source release into dist.apache.org dev repo.
Stage,sign and hash python binaries into dist.apache.ord dev repo python dir
Create a PR to update beam-site, changes includes:
Tasks you need to do manually
Set up a few environment variables to simplify the commands that follow. These identify the release candidate being built, and the branch where you will stage files. Start with RC_NUM equal to 1 and increment it for each candidate.
RC_NUM=1
Make sure your git config will maintain your account:
git config credential.helper store
Use Gradle release plugin to build the release artifacts, and push code and release tag to the origin repository (this would be the Apache Beam repo):
./gradlew release -Prelease.newVersion=${RELEASE}-SNAPSHOT \
-Prelease.releaseVersion=${RELEASE}-RC${RC_NUM} \
-Prelease.useAutomaticVersion=true --info --no-daemon
Use Gradle publish plugin to stage these artifacts on the Apache Nexus repository, as follows:
./gradlew publish -PisRelease --no-parallel --no-daemon
Review all staged artifacts. 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.
Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Beam, version X, release candidate Y”.
Attention: Only committer has permissions to perform following steps.
Copy the source release to the dev repository of dist.apache.org.
If you have not already, check out the Beam section of the dev repository on dist.apache.org via Subversion. In a fresh directory:
svn co https://dist.apache.org/repos/dist/dev/beam
Make a directory for the new release:
mkdir beam/${RELEASE}
cd beam/${RELEASE}
Download source zip from GitHub:
wget https://github.com/apache/beam/archive/release-${RELEASE}.zip
-O apache-beam-${RELEASE}-source-release.zip
Create hashes and sign the source distribution:
gpg --armor --detach-sig apache-beam-${RELEASE}-source-release.zip
sha512sum apache-beam-${RELEASE}-source-release.zip > apache-beam-${RELEASE}-source-release.zip.sha512
Add and commit all the files.
svn add beam/${RELEASE}
svn commit
Verify that files are present.
Build python binaries in release branch in sdks/python dir.
python setup.py sdist --format=zip
cd dist
cp apache-beam-${RELEASE}.zip staging/apache-beam-${RELEASE}-python.zip
cd staging
Create hashes and sign the binaries
gpg --armor --detach-sig apache-beam-${RELEASE}-python.zip
sha512sum apache-beam-${RELEASE}-python.zip > apache-beam-${RELEASE}-python.zip.sha512
Staging binaries
svn co https://dist.apache.org/repos/dist/dev/beam
cd beam/${RELEASE}
svn add *
svn commit
Verify that files are present.
Make sure you have tox installed:
pip install tox
Create the Python SDK documentation using sphinx by running a helper script.
cd sdks/python && tox -e docs
By default the Pydoc is generated in sdks/python/target/docs/_build. Let ${PYDOC_ROOT} be the absolute path to _build.
The final step of building the candidate is to propose a website pull request.
Start by updating release_latest version flag in the top-level _config.yml, and list the new release in the [Apache Beam Downloads]({{ site.baseurl }}/get-started/downloads/), linking to the source code download and the Release Notes in JIRA.
Beam publishes API reference manual for each release on the website. For Java SDK, that’s Javadoc.
One of the artifacts created in the release contains the Javadoc for the website. To update the website, you must unpack this jar file from the release candidate into the source tree of the website.
Add the new Javadoc to [SDK API Reference page]({{ site.baseurl }}/documentation/sdks/javadoc/) page, as follows:
org.apache.beam:beam-sdks-java-javadoc into some temporary location. Call this ${JAVADOC_TMP}.cp -r ${JAVADOC_TMP} src/documentation/sdks/javadoc/${RELEASE}.src/documentation/sdks/javadoc/current.md).Add the new Pydoc to [SDK API Reference page]({{ site.baseurl }}/documentation/sdks/pydoc/) page, as follows:
cp -r ${PYDOC_ROOT} src/documentation/sdks/pydoc/${RELEASE}..doctrees directory.src/documentation/sdks/pydoc/current.md).Finally, propose a pull request with these changes. (Don’t merge before finalizing the release.)
There is a wrapper repo beam-wheels to help build python wheels.
If you are interested in how it works, please refer to the structure section.
Please follow the user guide to build python wheels.
You can (optionally) also do additional verification by:
README.md, NOTICE, and LICENSE files.md5sum -c *.md5 and sha1sum -c *.sha1)gpg --verify apache-beam-1.2.3-python.zip.asc apache-beam-1.2.3-python.zip)grep for legal headers in each file.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) 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 and publishing the API reference manual [6]. * 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]. 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] link [2] link [3] https://dist.apache.org/repos/dist/release/beam/KEYS [4] link [5] link [6] link
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.
If there are no issues, reply on the vote thread to close the voting. Then, tally the votes in a separate email. 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!
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
./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 :beam-runners-direct-java:runQuickstartJavaDirect \
-Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \
-Pver=${RELEASE_VERSION}
Apex Local Runner
./gradlew :beam-runners-apex:runQuickstartJavaApex \
-Prepourl=https://repository.apache.org/content/repositories/orgapachebeam${KEY} \
-Pver=${RELEASE_VERSION}
Flink Local Runner
./gradlew :beam-runners-flink_2.11:runQuickstartJavaFlinkLocal \
-Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \
-Pver=${RELEASE_VERSION}
Spark Local Runner
./gradlew :beam-runners-spark:runQuickstartJavaSpark \
-Prepourl=https://repository.apache.org/content/repositories/orgapachebeam-${KEY} \
-Pver=${RELEASE_VERSION}
Dataflow Runner
./gradlew :beam-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)
Pre-request
Create your own BigQuery dataset
bq mk --project=${YOUR_GCP_PROJECT} ${YOUR_DATASET}
Create yout 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
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 :beam-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
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=${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} \
--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} \
--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.
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. The cherry-pick commits should then be proposed as the 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.
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 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.
twine upload apache-beam-${RELEASE}.zipNote: It is important to rename apache-beam-${RELEASE}-python.zip to apache-beam-${RELEASE}.zip before uploading, because PyPI expects a filename in the <package-name>-<package-version> format.
Copy the source release from the dev repository to the release repository at dist.apache.org using Subversion.
Move last release artifacts from dist.apache.org to archive.apache.org using Subversion. Then update download address for last release version, example PR.
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 github "$VERSION_TAG"
Merge the website pull request to [list the release]({{ site.baseurl }}/get-started/downloads/), publish the [Python API reference manual]({{ site.baseurl }}/documentation/sdks/pydoc/), and the [Java API reference manual]({{ site.baseurl }}/documentation/sdks/javadoc/) created earlier.
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.
Major or otherwise important releases should have a blog post. Write one if needed for this particular release. Minor releases that don’t introduce new major functionality don’t necessarily need to be blogged.
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!