...
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.)Configure git
to use this key when signing code by giving it your key ID, as follows: PMC member can refer following scripts to add your Apache GPG key to the KEYS in the release repository.
Code Block | ||
---|---|---|
| ||
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:
Code Block | ||
---|---|---|
| ||
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.
...
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:
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
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:
Code Block | ||
---|---|---|
| ||
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:
Code Block | ||
---|---|---|
| ||
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:Code Block language xml title 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.)
Code Block | ||
---|---|---|
| ||
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
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.)
Code Block | ||
---|---|---|
| ||
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:
Code Block | ||
---|---|---|
| ||
$ 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 |
...
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:
Code Block | ||
---|---|---|
| ||
$ git checkout release- 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:
Code Block | ||
---|---|---|
| ||
$ git checkout release-$SHORT_RELEASE_VERSION |
If this is a major release, the newly created branch needs If this is a major release, the newly created branch needs to be pushed to the official repository.
...
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 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 | ||
---|---|---|
| ||
RELEASE_CANDIDATE=$RC_NUM tools/releasing/create_release_branch.sh |
Tag the release commitUpdate branch version:
Code Block | ||
---|---|---|
| ||
$ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION tools/releasing/update_branch_version.sh |
Tag the release commit:
Code Block |
---|
git tag -s git tag -s ${TAG} -m "${TAG}" |
See Telling Git about your signing key
We now need to do several things:
- Create the source release archiveCreate 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:
Code Block | ||
---|---|---|
| ||
$ 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 |
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 artifactsFinally, we stage the maven artifacts:
Code Block | ||
---|---|---|
| ||
$ tools/releasing/deploy_staging_jars.sh |
...
Close the staging repository on Apache Nexus. When prompted for a description, enter “Apache Flink Table Store, 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 |
Stage source and binary releases on 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: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-table-store-${RELEASE_VERSION}-rc${RC_NUM}
Copy
all releasesource distributions,
hashes,
and
GPG
signature:
Code Block mv <flink-table-store-dir>/release/* flink/flink-table-store-${RELEASE_VERSION}-rc${RC_NUM}
Copy binary distributions, hashes, and GPG signature:
Code Block mv <flink-table-store-dir>/tools/releasing/release/* flink/flink-table-store-${RELEASE_VERSION}-rc${RC_NUM}
Add and Add and commit all the files.
Code Block language bash cd flink svn add flink-table-store-${RELEASE_VERSION}-rc${RC_NUM} svn commit -m "Apache Flink Table Store, version ${RELEASE_VERSION}, release candidate ${RC_NUM}"
Verify that files are present
...
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.apache.org
Subject: [VOTE] Apache Flink Table Store 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 Table Store,
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 Table Store source release to be deployed to dist.apache.org
b) Flink Table Store 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 Table Store 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 |
...
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:
Code Block | ||
---|---|---|
| ||
$ pip install --upgrade twine==1.12.0 |
Download the python artifacts from dist.apache.org and upload it to pypi.org:
...
language | text |
---|
...
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 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.
...
Code Block |
---|
$ svn move -m "Release Flink Table Store ${RELEASE_VERSION}" \
https://dist.apache.org/repos/dist/dev/flink/flink-table-store-${RELEASE_VERSION}-rc${RC_NUM} \
https://dist.apache.org/repos/dist/release/flink/flink-table-store-${RELEASE_VERSION}
|
...
If you have not already, check out the Flink section of the
release
repository ondist.apache.org
via Subversion. In a fresh directory:Code Block language bash 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 language bash svn remove flink-table-store-<version_to_remove> svn commit flink-table-store-<version_to_remove> svn commit -m "Remove old release for Apache Flink Table Store ${RELEASE_VERSION_MAJOR}"
Verify that files are removed
...
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
...
Code Block | ||
---|---|---|
| ||
From: Release Manager To: dev@flink.apache.org, user@flink.apache.org, user-zh@flink.apache.org, announce@apache.org Subject: [ANNOUNCE] Apache Flink Table Store 1.2.3 released The Apache Flink community is very happy to announce the release of Apache Flink Table Store 1.2.3. Apache Flink Table Store provides API and infrastructure that simplifies implementing distributed ML algorithms, and it also provides a library of off-the-shelf ML algorithmsFor building dynamic tables for both stream and batch processing in Flink, supporting high speed data ingestion and timely data query. Please check out the release blog post for an overview of the release: https://flink.apache.org/news/2020/04/07/release-table-store-0.1.0.html The release is available for download at: https://flink.apache.org/downloads.html Maven artifacts for Flink Table Store can be found at: https://search.maven.org/search?q=g:org.apache.flink%20mlflink%20table-store 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 |
...