Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Each release is executed by a Release Manager, who needs to be a Apache Flink committer and is selected among the by the Flink PMC members. 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.

...

  1. Decide to release
  2. Prepare for the release
  3. Build a release candidate
  4. Vote on the release candidate
  5. If necessary, fix any issues and go back to step 3.
  6. Finalize the release
  7. Promote the release
  8. Update flink-shaded dependencies in other repositories

Decide to release

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.

...

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.

One-time setup instructions

GPG Key

There was a change being made to the way how the flink-shaded releases are organized within git due to the fact that bugfix releases happen quite rarely. Changes were only performed on master. x.0 releases would be created by tagging the relevant commit on the master branch. This was done to reduce unnecessary effort. If it comes to a point where a bugfix release becomes necessary, one should go ahead and create a release branch release-x.0  (to match the naming scheme of the past branches) which should be based on the tag with the same name release-x.0.

Info

Branches are prefered by git in case of name collisions, i.e. git checkout release-13.0  will always check out the branch. The following command can be used to refer to the tag: git checkout refs/tags/release-13.0 .

One-time setup instructions

GPG Key

You need to have a GPG key to sign the release artifacts. Please be aware of the ASF-wide release signing guidelines. If you 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.

...

  • Create the source release archive
  • Deploy jar artifacts to the Apache Nexus Repository, which is the staging area for deploying the jars to Maven CentralMaven Central
  • Note: Please do not use VPN or change your IP address when stage artifacts to Apache Nexus Repository, it may lead to multiple staging repositories which is unexpected.
Code Block
languagebash
# tag release commit
git tag -s ${TAG} -m "${TAG}"

# create source release
cd ${FLINK_SHADED_DIR}/tools
RELEASE_VERSION=$RELEASE_VERSION releasing/create_source_release.sh 

# stage maven artifacts
cd ${FLINK_SHADED_DIR}/tools
releasing/deploy_staging_jars.sh

cd ${FLINK_SHADED_DIR}

...

Use reporter.apache.org to seed the information about the release into future project reports.

Checklist to declare the process completed

  1. Website pull request to list the release merged
  2. Release recorded in reporter.

...

  1. apache.org.
  2. Release announced on the dev@ mailing list.
  3. Prepare for the next development iteration by creating/merging a PR bumping the flink-shaded version (e.g. 725c0caf3ab)

Repositories that have the flink-shaded dependency included and need updates (flink-shaded  and shaded dependency versions):

Checklist to declare the process completed

...

Improve the process

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.

...