https://repository.apache.org/#welcome
This is based on the release guide of the Apache Beam project: https://beam.apache.org/contribute/release-guide/
Introduction
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.
Overview
The release process consists of several steps:
- Decide to release
- Prepare for the release
- Build a release candidate
- Vote on the release candidate
- If necessary, fix any issues and go back to step 3.
- Finalize the release
- Promote the release
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.
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
- Community agrees to release
- Community selects a Release Manager
Prepare for the release
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 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 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:
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 Flink’s KEYS
file in the release
repository 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.) PMC member can refer following scripts to add your Apache GPG key to the KEYS in the release repository.
svn co https://dist.apache.org/repos/dist/release/flink flink-dist-release-repo cd flink-dist-release-repo (gpg --list-sigs <YOUR_KEY_ID> && gpg --armor --export <YOUR_KEY_ID>) >> KEYS svn ci -m "[flink] Add <YOUR_NAME>'s public key"
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.
You may wish to start gpg-agent
to unlock your GPG key only once using your passphrase. Otherwise, you may need to enter this passphrase hundreds of times. The setup for gpg-agent
varies based on operating system, but may be something like this:
eval $(gpg-agent --daemon --no-grab --write-env-file $HOME/.gpg-agent-info) export GPG_TTY=$(tty) export GPG_AGENT_INFO
Access to Apache Nexus repository
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.flink
underStaging Profiles
. - Navigate to your
Profile
(top right dropdown menu of the page). - Choose
User Token
from the dropdown, then clickAccess 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, whereTOKEN_NAME
andTOKEN_PASSWORD
are your secret tokens:settings.xml<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>
Website development setup
Get 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 Release Notes in JIRA
JIRA automatically generates Release Notes based on the Fix Version
field applied to issues. Release Notes are intended fo 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 -Papache-release 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.)
RELEASE_VERSION="2.0.0" SHORT_RELEASE_VERSION="2.0" CURRENT_SNAPSHOT_VERSION="$SHORT_RELEASE_VERSION-SNAPSHOT" NEXT_SNAPSHOT_VERSION="2.1-SNAPSHOT" SHORT_NEXT_SNAPSHOT_VERSION="2.1"
If you are doing a new major/minor release (e.g. 2.0.0, 2.1.0), 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:
$ git checkout master $ RELEASE_VERSION=$SHORT_RELEASE_VERSION tools/releasing/create_release_branch.sh $ git checkout master $ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$NEXT_SNAPSHOT_VERSION tools/releasing/update_branch_version.sh $ git checkout release-$SHORT_RELEASE_VERSION
If you're creating a new bugfix release (e.g. 2.0.5), you will skip the above step and simply check out the the already existing branch for that version:
$ 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.toml
file:, as listed below.
baseURL = '//nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION' IsStable = true Version = "$RELEASE_VERSION" VersionTitle = "$SHORT_RELEASE_VERSION" Branch = "release-$SHORT_RELEASE_VERSION" MenuLinks = [ ["Project Homepage", "//flink.apache.org"], ["JavaDocs", "//nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION/api/java/"], ["PyDocs", "//nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION/api/python/"], ]
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 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.
For major/minor releases add a link to the release documentation in docs/config.toml
in the master branch.
$ git checkout master
PreviousDocs = [ ["$SHORT_RELEASE_VERSION", "https://nightlies.apache.org/flink/flink-ml-docs-release-$SHORT_RELEASE_VERSION"], ["2.0", "https://nightlies.apache.org/flink/flink-ml-docs-release-2.0"], ]
The rest of this guide assumes that commands are run in the root 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)
docs/config.toml
has been updated appropriately.- The new documentation for major releases is visible under https://ci.apache.org/projects/flink/flink-ml-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.
RC_NUM="1" TAG="release-${RELEASE_VERSION}-rc${RC_NUM}"
Tag and push the release commit:
git tag -s ${TAG} -m "${TAG}" git push <remote> refs/tags/${TAG}
We now need to do several things:
- Create the source release archive
- Create the Python artifacts
- 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:
$ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION tools/releasing/update_branch_version.sh $ RELEASE_VERSION=$RELEASE_VERSION tools/releasing/create_source_release.sh
Next, we build the Python artifacts:
$ RELEASE_VERSION=$RELEASE_VERSION tools/releasing/create_python_sdk_release.sh
You will be able to find the built source and Python release artifacts under the "release/" folder created under the project root directory.
Finally, we stage the maven artifacts:
$ 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 ML, version X, release candidate Y”.
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 ondist.apache.org
via Subversion. In a fresh directory:svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates
Make a directory for the new release:
mkdir flink/flink-ml-${RELEASE_VERSION}-rc${RC_NUM}
Copy all release distributions, hashes, and GPG signature:
mv <flink-ml-dir>/release/* flink/flink-ml-${RELEASE_VERSION}-rc${RC_NUM}
Add and commit all the files.
cd flink svn add flink-ml-${RELEASE_VERSION}-rc${RC_NUM} svn commit -m "Apache Flink ML, version ${RELEASE_VERSION}, release candidate ${RC_NUM}"
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.toml, and update the version/date in release_archive.yml, linking to the source code download and the Release Notes in JIRA. Also add a new blog entry announcing the release in docs/content/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.toml
to ensure that- the version constants refer to the new version
- the
baseurl
does not point toflink-ml-docs-master
butflink-ml-docs-release-X.Y
instead
You can (optionally) also do additional verification by:
Check hashes (e.g. shasum -c *.sha512)
- Check signatures (e.g.
gpg --verify flink-ml-1.2.3-source-release.tar.gz.asc flink-ml-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.
From: Release Manager To: dev@flink.apache.org Subject: [VOTE] Apache Flink ML Release 1.2.3, release candidate #3 Hi everyone, Please review and vote on the release candidate #3 for the version 1.2.3 of Apache Flink ML, as follows: [ ] +1, Approve the release [ ] -1, Do not approve the release (please provide specific comments) **Release Overview** As an overview, the release consists of the following: a) Flink ML source release to be deployed to dist.apache.org b) Flink ML Python source distributions to be deployed to PyPI c) Maven artifacts to be deployed to the Maven Central Repository **Staging Areas to Review** The staging areas containing the above mentioned artifacts are as follows, for your review: * All artifacts for a) and b) can be found in the corresponding dev repository at dist.apache.org [2], which are signed with the key with fingerprint FFFFFFFF [3] * All artifacts for b) can be found at PyPI [4] * All artifacts for c) can be found at the Apache Nexus Repository [5] Other links for your review: * JIRA release notes [6] * Source code tag "release-1.2.3-rc3" [7] * PR to update the website Downloads page to include Flink ML links [8] **Vote Duration** The voting time will run 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 [7] link [8] 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@flink.apache.org Subject: [RESULT] [VOTE] Apache Flink ML 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 (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:
$ pip install --upgrade twine==1.12.0
Download the python artifacts from dist.apache.org and upload it to pypi.org:
$ svn checkout https://dist.apache.org/repos/dist/dev/flink/flink-ml-${RELEASE_VERSION}-rc${RC_NUM} $ cd flink-ml-${RELEASE_VERSION}-rc${RC_NUM} $ python -m twine upload --repository-url https://upload.pypi.org/legacy/ \ apache-flink-ml-${RELEASE_VERSION}.tar.gz apache-flink-ml-${RELEASE_VERSION}.tar.gz.asc
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.
$ svn move -m "Release Flink ${RELEASE_VERSION}" \ https://dist.apache.org/repos/dist/dev/flink/flink-ml-${RELEASE_VERSION}-rc${RC_NUM} \ https://dist.apache.org/repos/dist/release/flink/flink-ml-${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.
svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates cd flink svn remove flink-ml-${RELEASE_VERSION}-rc* svn commit -m "Remove old release candidates for Apache Flink ML ${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 ondist.apache.org
via Subversion. In a fresh directory:svn checkout https://dist.apache.org/repos/dist/release/flink --depth=immediates cd flink
Remove files for outdated releases and commit the changes.
svn remove flink-ml-<version_to_remove> svn commit
Verify that files are removed
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}" refs/tags/${TAG}^{} -m "Release Flink ML ${RELEASE_VERSION}" git push <remote> refs/tags/release-${RELEASE_VERSION}
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 flink-web repository
1) Add a new entry for the new Flink ML release in the docs/data/release_archive.yml file.
2) Add download links for the new Flink ML release in the docs/data/flink_ml.yml file.
3) For major releases, update the following settings in the docs/config.toml file.
FLINK_ML_VERSION_STABLE: $RELEASE_VERSION FlinkMLStableShortVersion: $SHORT_RELEASE_VERSION
4) For major releases, add the release announcement under docs/content/posts.
5) Rebuild the website and push.
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.
Please send the email using your apache.org mailbox and also make sure you are using plain text mode.
From: Release Manager To: dev@flink.apache.org, user@flink.apache.org, user-zh@flink.apache.org, announce@apache.org Subject: [ANNOUNCE] Apache Flink ML 1.2.3 released The Apache Flink community is very happy to announce the release of Apache Flink ML 1.2.3. Apache Flink ML provides API and infrastructure that simplifies implementing distributed ML algorithms, and it also provides a library of off-the-shelf ML algorithms. Please check out the release blog post for an overview of the release: https://flink.apache.org/news/2020/04/07/release-ml-2.0.0.html The release is available for download at: https://flink.apache.org/downloads.html Maven artifacts for Flink ML can be found at: https://search.maven.org/search?q=g:org.apache.flink%20ml Python SDK for Flink ML published to the PyPI index can be found at: https://pypi.org/project/apache-flink-ml/ The full release notes are available in Jira: https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12315522&version=12346878 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:
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.
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.
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!