Build and stage Java artifacts with Maven)
Info |
---|
This is based on the release guide of the Apache Beam project: https://beam.apache.org/contribute/release-guide/ |
Expand |
---|
...
| ||
The Apache Flink 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 Flink 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 Flink community in a public vote. Each release is executed by a Release Manager, who is selected |
...
/proposed 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. Please remember that publishing software has legal consequences. This guide complements the foundation-wide Product Release Policy and Release Distribution Policy. |
Expand | ||
---|---|---|
| ||
The release process consists of several steps:
|
Expand | ||
---|---|---|
| ||
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. Checklist to proceed to the next step
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
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. One-time setup instructionsGPG KeyYou 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. Determine your Apache GPG Key and Key ID, as follows:
This will list your GPG keys. One of these should reflect your Apache account, for example:
Here, the key ID is the 8-digit hex string in the Now, add your Apache GPG key to the Flink’s |
...
in the |
...
PMC member can refer following scripts to add your Apache GPG key to the KEYS in the release repository.
| ||||
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.
...
Configure
You may drop the You may wish to start
Access to Apache Nexus repositoryConfigure access to the Apache Nexus repository, which enables final deployment of releases to the Maven Central Repository.
Website development setupGet ready for updating the Flink website by following the website development instructions. |
Create a new version in JIRA
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:
- In JIRA, navigate to the Flink
> Administration > Versions
. - Add a new release: choose the next minor version number compared to the one currently underway, select today’s date as the
Start Date
, and chooseAdd
.
Triage release-blocking issues in JIRA
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:
- If the issue has been resolved and JIRA was not updated, resolve it accordingly.
- If the issue has not been resolved and it is acceptable to defer this until the next release, update the
Fix Version
field to the new version you just created. Please consider discussing this with stakeholders and the dev@ mailing list, as appropriate. - If the issue has not been resolved and it is not acceptable to release until it is fixed, the release cannot proceed. Instead, work with the Flink community to resolve the issue.
Review and update documentation
There are a few pages in the documentation that need to be reviewed and updated for each release.
- Ensure that there exists a release notes page for each non-bugfix release (e.g., 1.5.0) in
./docs/release-notes
/, that it is up-to-date, and linked from the start page of the documentation. - Upgrading Applications and Flink Versions: https://ci.apache.org/projects/flink/flink-docs-master/ops/upgrading.html
- please extend this list.
Unless the pages have not been updated before, please create a JIRA ticket and mark it as release blocker.
Review Release Notes in JIRA
JIRA automatically generates Release Notes based on the Fix Version
field applied to issues. Release Notes are intended for Flink users (not Flink 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:
- Be appropriately classified as
Bug
,New Feature
,Improvement
, etc. - Represent noteworthy user-facing changes, such as new functionality, backward-incompatible API changes, or performance improvements.
- Have occurred since the previous release; an issue that was introduced and fixed between releases should not appear in the Release Notes.
- Have an issue title that makes sense when read on its own.
Adjust any of the above properties to the improve clarity and presentation of the Release Notes.
Ensure that the JIRA release notes are also included in the release notes of the documentation (see section "Review and update documentation").
Verify that a Release Build Works
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.
Set up a few environment variables to simplify Maven commands that follow. (We use bash
Unix syntax in this guide.)
GNU Tar Setup for MacSkip this step if you are not using a Mac. The default tar application on Mac does not support GNU archive format and defaults to Pax. This bloats the archive with unnecessary metadata that can result in additional files when decompressing (see 1.15.2-RC2 vote thread). Install gnu-tar and create a symbolic link to use in preference of the default tar program.
Create a new version in JIRAWhen 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:
(Note: Only PMC members have access to the project administration. If you do not have access, ask on the mailing list for assistance.) Triage release-blocking issues in JIRAThere could be outstanding release-blocking issues, which should be triaged before proceeding to build a release candidate. We track them by assigning a specific The list of release-blocking issues is available at the version status page. Triage each unresolved issue with one of the following resolutions:
Review and update documentationThere are a few pages in the documentation that need to be reviewed and updated for each release.
Cross team testingFor user facing features that go into the release we'd like to ensure they can actually be used by Flink users. To achieve this the release managers ensure that an issue for cross team testing is created in the Apache Flink Jira. This can and should be picked up by other community members to verify the functionality and usability of the feature.
Unless the pages have not been updated before, please create a JIRA ticket and mark it as release blocker.Setup environment variablesSet up a few environment variables to simplify commands that follow. (We use
| |||||||
Code Block | |||||||
---|---|---|---|---|---|---|---|
| |||||||
RELEASE_VERSION="1.
|
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/minor release, check out the version of the codebase from which you start the release. This may be HEAD
of the master
branch. Create a branch for the new version that we want to release before updating the master branch to the next development version:
Code Block | ||
---|---|---|
| ||
$ git checkout master
$ git checkout -b release-$SHORT_RELEASE_VERSION
$ git checkout master
$ cd tools
tools $ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$NEXT_SNAPSHOT_VERSION releasing/update_branch_version.sh
$ cd ..
$ git checkout release-$SHORT_RELEASE_VERSION |
If you're creating a new bugfix release, you will skip the above step and simply check out the the already existing branch for that version:
Code Block | ||
---|---|---|
| ||
$ git checkout release-$SHORT_RELEASE_VERSION |
If this is a major release, the newly created branch needs to be pushed to the official repository.
Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/_config.yml
file:, as listed below.
Code Block | ||
---|---|---|
| ||
version: $SHORT_RELEASE_VERSION
version_title: $SHORT_RELEASE_VERSION
github_branch: release-$SHORT_RELEASE_VERSION
base_url: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
stable_base_url: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
javadocs_base_url: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
pythondocs_base_url: //ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION
is_stable: true |
After updating the docs configuration and pushing the new major release branch, as the last step you should also update the documentation build bot to also build the documentation for the new release branch. Check Managing Flink Documentation on details on how to do that. You may also want to manually trigger a build to make the changes visible as soon as possible.
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
- Release Manager’s GPG key is published to
dist.apache.org
- Release Manager’s GPG key is configured in
git
configuration - Release Manager has
org.apache.flink
listed underStaging Profiles
in Nexus - Release Manager’s Nexus User Token is configured in
settings.xml
- JIRA release item for the subsequent release has been created
- There are no release blocking JIRA issues
- Release Notes in JIRA have been audited and adjusted
- Release branch has been created and pushed if it is a major release.
- Originating branch has the version information updated to the new version
- (major/minor only) Jenkins deployment updated to create snapshot artifacts for release branch (see here)
- (major/minor only) Cron end-to-end-tests branch setup for release branch
- (major/minor only) Update upgrade compatibility table (
docs/ops/upgrading.md.
docs/_config.yml
has been updated appropriately.- The new documentation for major releases is visible under https://ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION (after at least one doc build finishes).
- The new documentation for major releases do not contain "-SNAPSHOT" in its version title, and all links refer to the corresponding version docs instead of master.
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 and Python artifacts
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.
Code Block | ||
---|---|---|
| ||
RC_NUM="1"
TAG="release-${RELEASE_VERSION}-rc${RC_NUM}" |
Now, create a release branch:
Code Block | ||
---|---|---|
| ||
$ cd tools
tools $ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION RELEASE_CANDIDATE=$RC_NUM releasing/create_release_branch.sh |
Tag the release commit:
Code Block |
---|
git tag -s ${TAG} -m "${TAG}" |
We now need to do several things:
- Create the source release archive
- Deploy jar artefacts to the Apache Nexus Repository, which is the staging area for deploying the jars to Maven Central
- Create binary convenience releases for different Hadoop versions
You might want to create a directory on your local machine for collecting the various source and binary releases before uploading them. Creating the binary releases is a lengthy process but you can do this on a another machine (for example, in the "cloud"). When doing this, you can skip signing the release files on the remote machine, download them to your local machine and sign them there.
First, we build the source release:
Code Block | ||
---|---|---|
| ||
tools $ RELEASE_VERSION=$RELEASE_VERSION releasing/create_source_release.sh
|
Next, we stage the maven artifacts:
Code Block | ||
---|---|---|
| ||
tools $ releasing/deploy_staging_jars.sh |
Review all staged artifacts (https://repository.apache.org/). They should contain all relevant parts for each module, including pom.xml
, jar, test jar, source, test source, javadoc, etc. Carefully review any new artifacts.
Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Flink, version X, release candidate Y”.
Finally, we create the binary convenience release files:
Code Block | ||
---|---|---|
| ||
tools $ RELEASE_VERSION=$RELEASE_VERSION releasing/create_binary_release.sh |
If you want to run this step in parallel on a remote machine you have to make the release commit available there (for example by pushing to a repository). This is important: the commit inside the binary builds has to match the commit of the source builds and the tagged release commit. When building remotely, you can skip gpg signing by setting SKIP_GPG=true
. You would then sign the files manually after downloading them to your machine:
Code Block | ||
---|---|---|
| ||
for f in flink-*-bin*.tgz; do gpg --armor --detach-sig $f; done
gpg --armor --detach-sig apache-flink-*.tar.gz |
Stage source and binary releases on dist.apache.org
Copy the source release to the dev repository of dist.apache.org
.
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 | ||
---|---|---|
| ||
svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates |
Make a directory for the new release:
Code Block | ||
---|---|---|
| ||
mkdir flink/flink-${RELEASE_VERSION}-rc${RC_NUM} |
Review Release Notes in JIRAJIRA automatically generates Release Notes based on the 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:
Adjust any of the above properties to the improve clarity and presentation of the Release Notes. Ensure that the JIRA release notes are also included in the release notes of the documentation (see section "Review and update documentation"). Content of Release Notes field from JIRA ticketsTo get the list of "release notes" field from JIRA, you can ran the following script using JIRA REST API (notes the maxResults limits the number of entries):
Verify Java and Maven VersionAll of the following steps require to use Maven 3.8.6 and Java 8. Modify your PATH environment variable accordingly if needed.
Clone flink into a fresh workspaceCreate a new directory for this release and clone the Flink repo from github to ensure you have a clean workspace. This step is optional. Verify that a Release Build WorksRun Verify that no exclusions were erroneously added to the japicmp plugin that break compatibility guaranteesCheck the exclusions for the japicmp-maven-plugin in the root pom for exclusions that:
Any such exclusion must be properly justified, in advance. Create a release branchRelease 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. Most of the following commands have to be executed in the
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
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 and Python artifactsSet up a few environment variables to simplify Maven commands that follow. This identifies the release candidate being built. Start with
Now, create a release branch ( this step can not be skipped for minor releases):
Tag the release commit:
You can use We now need to do several things:
You might want to create a directory on your local machine for collecting the various source and binary releases before uploading them. Creating the binary releases is a lengthy process but you can do this on a another machine (for example, in the "cloud"). When doing this, you can skip signing the release files on the remote machine, download them to your local machine and sign them there. First, we build the source release:
Next, we stage the maven artifacts:
Review all staged artifacts in the staging repositories(https://repository.apache.org/#stagingRepositories). They should contain all relevant parts for each module, including Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Flink, version X, release candidate Y”. Then, you need to build the PyFlink wheel packages.(since 1.11)
Finally, we create the binary convenience release files:
If you want to run this step in parallel on a remote machine you have to make the release commit available there (for example by pushing to a repository). This is important: the commit inside the binary builds has to match the commit of the source builds and the tagged release commit. When building remotely, you can skip gpg signing by setting
The release manager need to make sure the PyPI project `apache-flink` and `apache-flink-libraries` has enough available space for the python artifacts. The remaining space must be larger than the size of `tools/releasing/release/python`. Login with the PyPI admin account (account info is only available to PMC members) and check the remaining space in project settings. Request an increase if there's not enough space. Note, it could take some days for PyPI to review our request. Stage source and binary releases on dist.apache.orgCopy the source release to the dev repository of
(Push the release tag) If you haven't pushed the release tag yet, here's the command:
Propose a pull request for website updatesThe final step of building the candidate is to propose a website pull request containing the following changes:
Don’t merge the PRs before finalizing the release. Checklist to proceed to the next step
You can (optionally) also do additional verification by:
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
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.
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 For cancelling a release, the release manager needs to send an email to the release candidate thread, stating that the release candidate is officially cancelled. Next, all artifacts created specifically for the RC in the previous steps need to be removed:
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.
Checklist to proceed to the finalization step
|
Expand | ||
---|---|---|
| ||
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 Once all issues have been resolved, you should go back and build a new release candidate with these changes. Checklist to proceed to the next step
|
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
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. Deploy Python artifacts to PyPI (Since 1.9)Release manager should create a PyPI account and ask the PMC add this account to pyflink collaborator list with Maintainer role (The PyPI admin account info can be found here. NOTE, only visible to PMC members) to deploy the Python artifacts to PyPI. The artifacts could be uploaded using twine(https://pypi.org/project/twine/). To install twine, just run:
Note: Please ensure that the version of
Download the python artifacts from dist.apache.org and upload it to pypi.org:
If upload failed or incorrect for some reason(e.g. network transmission problem), you need to delete the uploaded release package of the same version(if exists) and rename the artifact to apache-flink-${RELEASE_VERSION}.post0.tar.gz, then re-upload. Note: re-uploading to pypi.org must be avoided as much as possible because it will cause some irreparable problems. If that happens, users cannot install the apache-flink package by explicitly specifying the package version, i.e. the following command "pip install apache-flink==${RELEASE_VERSION}" will fail. Instead they have to run "pip install apache-flink" or "pip install apache-flink==${RELEASE_VERSION}.post0" to install the apache-flink package. Deploy artifacts to Maven Central RepositoryUse the Apache Nexus repository to release the staged binary artifacts to the Maven Central repository. In the Deploy source and binary releases to dist.apache.orgCopy the source and binary releases from the
(Note: Only PMC members have access to the release repository. If you do not have access, ask on the mailing list for assistance.) Remove old release candidates from dist.apache.orgRemove the old release candidates from https://dist.apache.org/repos/dist/dev/flink using Subversion.
Git tagCreate and push a new Git tag for the released version by copying the tag for the final release candidate, as follows:
Mark the version as released in JIRAIn JIRA, inside version management, hover over the current release and a settings menu will appear. Click (Note: Only PMC members have access to the project administration. If you do not have access, ask on the mailing list for assistance.) If PRs have been merged to the release branch after the the last release candidate was tagged, make sure that the corresponding Jira tickets have the correct Fix Version set. Publish the Dockerfiles for the new releaseNote: the official Dockerfiles fetch the binary distribution of the target Flink version from an Apache mirror. After publishing the binary release artifacts, mirrors can take some hours to start serving the new artifacts, so you may want to wait to do this step until you are ready to continue with the "Promote the release" steps below. Follow the instructions in the flink-docker repo to build the new Dockerfiles and send an updated manifest to Docker Hub so the new images are built and published.
Checklist to proceed to the next step
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Once the release has been finalized, the last step of the process is to promote the release within the project and beyond. Please wait for 24h after finalizing the release in accordance with the ASF release policy. Update japicmp configurationUpdate the japicmp reference version and wipe exclusions / enable API compatibility checks for For a new major release (x.y.0), run the same command also on the master branch for updating the japicmp reference version and removing out-dated exclusions in the japicmp configuration. Make sure that all Maven artifacts are already pushed to Maven Central. Otherwise, there's a risk that CI fails due to missing reference artifacts.
Merge website pull requestMerge the website pull request to list the release. Make sure to regenerate the website as well, as it isn't build automatically. Remove outdated versionsdist.apache.orgFor a new major release remove all release files older than 2 versions, e.g., when releasing 1.7, remove all releases <= 1.5. For a new bugfix version remove all release files for previous bugfix releases in the same series, e.g., when releasing 1.7.1, remove the 1.7.0 release.
|
Copy Flink source/binary distributions, hashes, and GPG signature:
Code Block |
---|
mv <flink-dir>/tools/releasing/release/* flink/flink-${RELEASE_VERSION}-rc${RC_NUM} |
Add and commit all the files.
Code Block | ||
---|---|---|
| ||
cd flink
svn add flink-${RELEASE_VERSION}-rc${RC_NUM}
svn commit |
...
Verify that files are present
Propose a pull request for website updates
The final step of building the candidate is to propose a website pull request.
Start by updating the variables for the latest released version in the top-level _config.yml
, and list the new release in downloads.md
, linking to the source code download and the Release Notes in JIRA. Also add a new blog entry announcing the release in _posts
.
Finally, propose a pull request with these changes. (Don’t merge before finalizing the release.)
Checklist to proceed to the next step
- Maven artifacts deployed to the staging repository of repository.apache.org
- Source distribution deployed to the dev repository of dist.apache.org
- Website pull request proposed to list the release
- Check
docs/_config.yml
to ensure that- the version constants refer to the new version
- the
baseurl
does not point toflink-docs-master
butflink-docs-release-X.Y
instead
You can (optionally) also do additional verification by:
Check hashes (e.g. shasum *.sha512 > checklist.chk; shasum -c checklist.chk)
- Check signatures (e.g.
gpg --verify flink-1.2.3-source-release.tar.gz.asc flink-1.2.3-source-release.tar.gz
) grep
for legal headers in each file.
Vote on the release candidate
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.
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.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 and binary convenience releases to be deployed to dist.apache.org [2], which are signed with the key with fingerprint FFFFFFFF [3],
* all artifacts to be deployed to the Maven Central Repository [4],
* source code tag "release-1.2.3-rc3" [5],
* website pull request listing the new release and adding announcement blog post [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
[3] https://dist.apache.org/repos/dist/release/flink/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.
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.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! |
Checklist to proceed to the finalization step
- Community votes to release the proposed candidate, with at least three approving PMC votes
Fix any issues
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.
Checklist to proceed to the next step
- Issues identified during vote have been resolved, with fixes committed to the release branch.
Finalize the release
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.
Deploy Python artifacts to PyPI (Starting from 1.10)
Release manager should get the pypi account and password from PMC to deploy the Python artifacts to PyPI. The artifacts could be uploaded using twine(https://pypi.org/project/twine/). To install twine, just run:
Code Block | ||
---|---|---|
| ||
pip install --upgrade twine==1.12.0 |
Download the python artifacts from dist.apache.org and upload it to pypi.org:
Code Block | ||
---|---|---|
| ||
|
If upload failed or incorrect for some reason(e.g. network transmission problem), you need to delete the uploaded release package of the same version(if exists) and rename the artifact to apache-flink-${RELEASE_VERSION}.post0.tar.gz, then re-upload.
Note: re-uploading to pypi.org must be avoided as much as possible because it will cause some irreparable problems. If that happens, users cannot install the apache-flink package by explicitly specifying the package version, i.e. the following command "pip install apache-flink==${RELEASE_VERSION}" will fail. Instead they have to run "pip install apache-flink" or "pip install apache-flink==${RELEASE_VERSION}.post0" to install the apache-flink package.
Deploy artifacts to Maven Central Repository
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 orgapacheflink-XXX
entry and click Release
. Drop all other release candidates that are not being released.
Deploy source and binary releases to dist.apache.org
Copy the source and binary releases from the dev
repository to the release
repository at dist.apache.org
using Subversion.
Code Block |
---|
svn move -m "Release Flink ${RELEASE_VERSION}" https://dist.apache.org/repos/dist/dev/flink/flink-${RELEASE_VERSION}-rc${RC_NUM} https://dist.apache.org/repos/dist/release/flink/flink-${RELEASE_VERSION}
|
Remove old release candidates from dist.apache.org
Remove the old release candidates from https://dist.apache.org/repos/dist/dev/flink using Subversion.
Code Block | ||||
---|---|---|---|---|
| ||||
svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates
cd flink
svn remove flink-${RELEASE_VERSION}-rc*
svn commit -m "Remove old release candidates for Apache Flink ${RELEASE_VERSION}" |
Remove outdated versions from dist.apache.org
For a new major release remove all release files older than 2 versions, e.g., when releasing 1.7, remove all releases <= 1.5.
For a new bugfix version remove all release files for previous bugfix releases in the same series, e.g., when releasing 1.7.1, remove the 1.7.0 release.
If you have not already, check out the Flink section of the release
repository on dist.apache.org
via Subversion. In a fresh directory:
Code Block | ||
---|---|---|
| ||
svn checkout https://dist.apache.org/repos/dist/release/flink --depth=immediates
cd flink |
Remove files for outdated releases and commit the changes.
Code Block | ||
---|---|---|
| ||
svn remove flink-<version_to_remove>
svn commit |
...
Verify that files are removed
CIDisable the cron job for the now-unsupported version from (tools/azure-pipelines/build-apache-repo.yml) in the respective branch. Apache mailing listsAnnounce 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.
RecordkeepingUse reporter.apache.org to seed the information about the release into future project reports. (Note: Only PMC members have access report releases. If you do not have access, ask on the mailing list for assistance.) Flink blogMajor 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 (see flink-web PR #581 for Flink 1.15.3 as an example for a minor release blog post). Please make sure that the release notes of the documentation (see section "Review and update documentation") are linked from the blog post of a major release.
Social mediaTweet, post on Facebook, LinkedIn, and other platforms. Ask other contributors to do the same. Flink Release Wiki pageAdd a summary of things that went well or that went not so well during the release process. This can include feedback from contributors but also more generic things like the release have taken longer than initially anticipated (and why) to give a bit of context to the release process. End of Life for Unsupported versionsFor major versions only. As per our support policy for old Flink versions when we release a new 1.x version we should start a discussion thread to end support for old versions.
Checklist to declare the process completed
|
Git tag
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}
Mark the version as released in JIRA
In JIRA, inside version management, hover over the current release and a settings menu will appear. Click Release
, and select today’s date.
Update website to point to new stable release documentation (for major releases only)
In our website repository flink-web
, for major releases we need to update the website to point to the new stable release.
In the _config.yml
file under the root directory, update the following settings:
Code Block | ||
---|---|---|
| ||
FLINK_VERSION_STABLE: $RELEASE_VERSION
FLINK_VERSION_STABLE_SHORT: $SHORT_RELEASE_VERSION
stable: $SHORT_RELEASE_VERSION
snapshot: $SHORT_NEXT_SNAPSHOT_VERSION
docs-stable: "https://ci.apache.org/projects/flink/flink-docs-release-$SHORT_RELEASE_VERSION" |
Finally, rebuild the website and push.
Add download links for the new release to the website
In the _config.yml
file under the root directory of flink-web
, you will find a list of download links for previous releases.
Following the same format,
- add a new entry to
release_archive.flink
- for major releases, add a new entry to
flink_releases
for the release binaries and sources - for minor releases, update the entry for the previous release in the series in
flink_releases
Please pay notice to the ids assigned to the download entries. They should be unique and reflect their corresponding version number.
Checklist to proceed to the next step
- Python artifacts released and indexed in the PyPI Repository
- Maven artifacts released and indexed in the Maven Central Repository (usually takes about a day to show up)
- Source & binary distributions available in the release repository of https://dist.apache.org/repos/dist/release/flink/
- Dev repository https://dist.apache.org/repos/dist/dev/flink/ is empty
- Release tagged in the source code repository
- Release version finalized in JIRA. (Note: Not all committers have administrator access to JIRA. If you end up getting permissions errors ask on the mailing list for assistance.)
- Website contains links to new release binaries and sources in download page.
- For major releases, the front page references the correct new major release version and directs to the correct link.
Promote the release
Once the release has been finalized, the last step of the process is to promote the release within the project and beyond. Please wait for 24h after finalizing the release in accordance with the ASF release policy.
Merge website pull request
Merge the website pull request to list the release. Make sure to regenerate the website as well, as it isn't build automatically.
Apache mailing lists
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.
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.apache.org, user@flink.apache.org, announce@apache.org
Subject: [ANNOUNCE] Apache Flink 1.2.3 released
The Apache Flink community is very happy to announce the release of Apache Flink 1.2.3, which is the third bugfix release for the Apache Flink 1.2 series.
Apache Flink® is an open-source stream processing framework for distributed, high-performing, always-available, and accurate data streaming applications.
The release is available for download at:
https://flink.apache.org/downloads.html
Please check out the release blog post for an overview of the improvements for this bugfix release:
<blob post link>
The full release notes are available in Jira:
<jira release notes link>
We would like to thank all contributors of the Apache Flink community who made this release possible!
Regards,
Release Manager
|
Recordkeeping
Use reporter.apache.org to seed the information about the release into future project reports.
Flink blog
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.
Please make sure that the release notes of the documentation (see section "Review and update documentation") are linked from the blog post of a major release.
We usually include the names of all contributors in the announcement blog post. Use the following command to get the list of contributors:
Code Block |
---|
git log --pretty="%an%n%cn" <fromCommit>..<toCommit> | sort | uniq | tr "\n" "," | sed 's/,/, /g' |
Social media
Tweet, post on Facebook, LinkedIn, and other platforms. Ask other contributors to do the same.
Checklist to declare the process completed
...
- Change
version
fromx.y-SNAPSHOT
tox.y.z
, i.e.1.6-SNAPSHOT
to1.6.0
- Change
version_title
fromx.y-SNAPSHOT
tox.y
, i.e.1.6-SNAPSHOT
to1.6
- Change
github_branch
frommaster
torelease-x.y
, i.e.master
torelease-1.6
- Change
baseurl
from//ci.apache.org/projects/flink/flink-docs-master
to//ci.apache.org/projects/flink/flink-docs-release-x.y
- Change
javadocs_baseurl
from//ci.apache.org/projects/flink/flink-docs-master
to//ci.apache.org/projects/flink/flink-docs-release-x.y
- Change
is_stable
totrue
...
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.
...