Page History

...

Run mvn -Prelease clean install to ensure that the build processes that are specific to that profile are in good shape.

Create a release branch

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 code repository (you should probably do this once the whole process is done), and update version information on the original 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 branch of the release being patched. (Please make sure your cloned repository is up-to-date before starting.)

$ git checkout <master branch OR release tag>

Set up a few environment variables to simplify Maven commands that follow. (We use bash Unix syntax in this guide.)

Checklist to proceed to the next step

1. Release Manager’s GPG key is published to dist.apache.org
2. Release Manager has org.apache.flink listed under Staging Profiles in Nexus
3. Release Manager’s Nexus User Token is configured in settings.xml

Build a release candidate

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.

Prepare environment

Check out the commit from which you intend to create the release, and run these commands in the flink-shaded directory:

# Set up a few environment variables to simplify Maven commands that follow.
# (We use bash Unix syntax in this guide.)
export 

RELEASE_VERSION="4.0"
export NEXT_VERSION="5.0"

Most of the following commands have to be executed in the tools directory, we will prefix the command prompt to make this explicit.

If you are doing a new major release, first create a branch for the new version that we want to release before updating the master branch to the next development version:

$ git checkout -b release-$RELEASE_VERSION
$ git checkout master
$ cd tools
tools $ OLD_VERSION=$RELEASE_VERSION NEW_VERSION=$NEXT_VERSION releasing/update_branch_version.sh
$ cd ..
git checkout release-$RELEASE_VERSION

If you're creating a new minor release, you will skip the above step and simply check out the the already existing branch for that version:

$ git checkout release-$RELEASE_VERSION

The rest of this guide assumes that commands are run in the root (or tools directory) of a repository on the branch of the release version with the above environment variables set.

Checklist to proceed to the next step

1. Release Manager’s GPG key is published to dist.apache.org
2. Release Manager has org.apache.flink listed under Staging Profiles in Nexus
3. Release Manager’s Nexus User Token is configured in settings.xml
4. Release branch has been created
5. Originating branch has the version information updated to the new version

Build a release candidate

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.

Build and stage Java artifacts with Maven

Set up a few environment variables to simplify Maven commands that follow. This identifies the release candidate being built. Start with RC_NUM equal to 1 and increment it for each candidate.

RC_NUM="1"
TAG="release-${RELEASE_VERSION}-rc${RC_NUM}"

Now, create a release branch:

$ cd tools
tools $ RELEASE_VERSION=$RELEASE_VERSION RELEASE_CANDIDATE=$RC_NUM releasing/create_release_branch.sh

Tag the release commit:

git tag -s ${TAG} -m "${TAG}"

We now need to do several things:

• Create the source release archive
• Deploy jar artifacts to the Apache Nexus Repository, which is the staging area for deploying the jars to Maven Central

First, we build the source release:

tools $ RELEASE_VERSION=$RELEASE_VERSION releasing/create_source_release.sh
 

Next, we stage the maven artifacts:

# This must be incremented for each release candidate
export RC_NUM="1"
export TAG="release-${RELEASE_VERSION}-rc${RC_NUM}"
FLINK_SHADED_DIR=$(pwd)

Build and stage Java artifacts with Maven

We now need to do several things:

• Create the source release archive
• Deploy jar artifacts to the Apache Nexus Repository, which is the staging area for deploying the jars to Maven Central

# 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

tools $ releasing/deploy_staging_jars.sh

cd ${FLINK_SHADED_DIR}

Review all staged artifacts (https://repository.apache.org/). They should contain a .pom and .jar file for each module. Carefully review any new artifacts.

...

1. If you have not already, check out the Flink section of the dev repository on dist.apache.org via Subversion. In a fresh directory:

   Code Block
   language bash
   svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates

   Make a directory for the new release:

   Code Block
   language bash
   mkdir flink/flink-shaded-${RELEASE_VERSION}-rc${RC_NUM}

   Copy Flink source distributions, hashes, and GPG signature.

   Code Block
   mv <flink-shaded-dir>/tools/release/* # make a directory for the new release mkdir flink/flink-shaded-${RELEASE_VERSION}-rc${RC_NUM}

   Add and commit all the files.

   Code Block
   language bash
   cd flink svn add flink-shaded-${RELEASE_VERSION}-rc${RC_NUM} svn commit

2. Verify that files are present.

...

1. # copy Flink source distributions, hashes, and GPG signature mv ${FLINK_SHADED_DIR}/tools/release/* flink/flink-shaded-${RELEASE_VERSION}-rc${RC_NUM} pushd flink svn add flink-shaded-${RELEASE_VERSION}-rc${RC_NUM} svn commit -m "Add flink-shaded ${RELEASE_VERSION}-rc${RC_NUM} popd

   
   

2. Verify that files are present

...

1. .

Propose a pull request for website updates

...

From: Release Manager
To: dev@flink.apache.org
Subject: [VOTE] Release flink-shaded X.Y, release candidate #Z
Content:

echo "
Hi everyone,
Please review and vote on the release candidate #Z#${RC_NUM} for the version X.Y ${RELEASE_VERSION}, 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 are signed with the key with fingerprint FFFFFFFF$(git config user.signingKey) [3],
* all artifacts to be deployed to the Maven Central Repository [4],
* source code tag "release-X.Y-rcZ\"${TAG}\" [5],
* website pull request listing the new release [6].

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
[[1] link
[2] https://dist.apache.org/repos/dist/dev/flink/flink-shaded-${RELEASE_VERSION}-rc${RC_NUM}
[3] https://dist.apache.org/repos/dist/release/flink/KEYS
[4] link
[5] linkhttps://github.com/apache/flink-shaded/releases/tag/${TAG}
[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.

...

Create a new Git tag for the released version by copying the tag for the final release candidate, as follows:

git tag -s "release-${RELEASE_VERSION}" ${TAG}

...

git push upstream 

...

release-${RELEASE_VERSION}

Mark the version as released in JIRA

...