...
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.
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
- 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>
...
Verify that a Release Build Works
Run mvn -Papache-release,run-e2e-tests clean install
to ensure that the build processes that are specific to that profile are in good shape.
...
Code Block | ||
---|---|---|
| ||
RELEASE_VERSION="2.1.0" SHORT_RELEASE_VERSION="2.1" CURRENT_SNAPSHOT_VERSION="$SHORT_RELEASE_VERSION-SNAPSHOT" NEXT_SNAPSHOT_VERSION="2.2-SNAPSHOT" SHORT_NEXT_SNAPSHOT_VERSION="2.2" SHORT_PREVIOUS_RELEASE_VERSION="2.0" |
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 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
$ PREVIOUS_RELEASE_VERSION=$SHORT_PREVIOUS_RELEASE_VERSION CURRENT_RELEASE_VERSION=$SHORT_RELEASE_VERSION tools/releasing/update_playground_links.sh
$ 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 |
...
Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/_config.ymltoml
file:, as listed below.
Code Block | ||
---|---|---|
| ||
version: $RELEASE_VERSION version_title: $SHORT_RELEASE_VERSION github_branch: release-$SHORT_RELEASE_VERSION baseurl: //cibaseURL = '//nightlies.apache.org/projects/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION javadocs_baseurl: //ci.apache.org/projects/flink/flink-statefun-docs-release-' IsStable = true Version = "$RELEASE_VERSION" VersionTitle = "$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 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 of a repository on the branch of the release version with the above environment variables set.
Checklist to proceed to the next step
...
"
Branch = "release-$SHORT_RELEASE_VERSION"
MenuLinks = [
["Project Homepage", "//flink.apache.org"],
["JavaDocs", "//nightlies.apache.org/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION/api/java/"],
] |
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.
Code Block | ||
---|---|---|
| ||
$ git checkout master |
Code Block | ||
---|---|---|
| ||
PreviousDocs = [
["$SHORT_RELEASE_VERSION", "https://nightlies.apache.org/flink/flink-statefun-docs-release-$SHORT_RELEASE_VERSION"],
["3.1", "https://nightlies.apache.org/flink/flink-statefun-docs-release-3.1"],
["3.0", "https://nightlies.apache.org/ |
...
flink/flink-statefun-docs-release- |
...
3.0"],
["2.2", "https://nightlies.apache.org/flink/flink-statefun-docs-release-2.2"]
] |
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
docs/config.toml
has been updated appropriately.- The new documentation for major releases is visible under https://ci.apache.org/projects/flink/flink-statefun-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 candidate branch
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 candidate branch:
Code Block | ||
---|---|---|
| ||
RELEASE_CANDIDATE=$RC_NUM tools/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
- 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:
Code Block | ||
---|---|---|
| ||
$ RELEASE_VERSION=$RELEASE_VERSION tools/releasing/create_source_release.sh |
Next, we build the Python artifacts:
Code Block | ||
---|---|---|
| ||
$ RELEASE_VERSION=$RELEASE_VERSION RELEASE_CANDIDATE=$RC_NUM tools/releasing/create_pythonrelease_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:
Code Block | ||
---|---|---|
| ||
$branch.sh OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION tools/releasing/deployupdate_stagingbranch_jarsversion.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 Stateful Functions, 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 on dist.apache.org
via Subversion. In a fresh directory:
Tag the release commit:
Code Block |
---|
git tag -s ${TAG} -m "${TAG}"
git tag -s "statefun-sdk-go/v${RELEASE_VERSION}-rc${RC_NUM}" -m "${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:
Code Block | ||
---|---|---|
|
...
svn checkout https://dist.apache.org/repos/dist/dev/flink --depth=immediates
$ RELEASE_VERSION=$RELEASE_VERSION tools/releasing/create_source_release.sh |
Next, we build the Python artifacts
...
:
Code Block | ||
---|---|---|
|
...
mkdir flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM}
Copy all release distributions, hashes, and GPG signature:
Code Block |
---|
mv <flink-statefun-dir>/release/* flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} |
Add and commit all the files.
Code Block | ||
---|---|---|
| ||
cd flink
svn add flink-statefun-${RELEASE_VERSION}-rc${RC_NUM}
svn commit -m "Apache Flink Stateful Functions, version ${RELEASE_VERSION}, release candidate ${RC_NUM}" |
$ 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:
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 Stateful Functions, 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: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-statefun-${RELEASE_VERSION}-rc${RC_NUM}
Copy all release distributions, hashes, and GPG signature:
Code Block mv <flink-statefun-dir>/release/* flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM}
Add and commit all the files.
Code Block language bash cd flink svn add flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} svn commit -m "Apache Flink Stateful Functions, version ${RELEASE_VERSION}, release candidate ${RC_NUM}"
Verify that files are present
(Push the release tag)
If you haven't pushed the release tag yet, here's the command:
Code Block | ||||
---|---|---|---|---|
| ||||
git push <remote> refs/tags/release-${RELEASE_VERSION}-rc${RC_NUM}
git push <remote> refs/tags/statefun-sdk-go/v${RELEASE_VERSION}-rc${RC_NUM} |
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.toml
to ensure that- the version constants refer to the new version
- the
baseurl
does not point toflink-statefun-docs-master
butflink-statefun-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-statefun-1.2.3-source-release.tar.gz.asc flink-statefun-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] Apache Flink Stateful Functions 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 Stateful Functions,
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) Stateful Functions canonical source distribution, to be deployed to the release repository at dist.apache.org
b) Stateful Functions Python SDK distributions to be deployed to PyPI
c) Maven artifacts to be deployed to the Maven Central Repository
d) Dockerfiles for new images to be deployed to Docker Hub
**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]
* All artifacts for c) can be found at the Apache Nexus Repository [3]
* PR for new Dockerfiles for this release [4]
All artifacts are signed with the key FFFFFFFFFFFFFFFFFFFFFF [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 Stateful Functions 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] link
[4] link
[5] https://dist.apache.org/repos/dist/release/flink/KEYS
[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.
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.apache.org
Subject: [RESULT] [VOTE] Apache Flink Stateful Functions 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:
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 | ||
---|---|---|
| ||
$ svn checkout https://dist.apache.org/repos/dist/dev/flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM}
$ cd flink-statefun-${RELEASE_VERSION}-rc${RC_NUM}
$ twine upload --repository-url https://upload.pypi.org/legacy/ \
apache-flink-statefun-${RELEASE_VERSION}.tar.gz apache-flink-statefun-${RELEASE_VERSION}.tar.gz.asc \
apache_flink_statefun-${RELEASE_VERSION}-py3-none-any.whl apache_flink_statefun-${RELEASE_VERSION}-py3-none-any.whl.asc |
Deploy JavaScript SDK to npm
The release manager should create an npmjs.com account and ask the PMC to be added as a maintainer to the apache-flink-statfun package. After being added as a maintainer it is possible to publish the JavaScript SDK by using npm.
Code Block | ||||
---|---|---|---|---|
| ||||
cd flink-statefun/statefun-sdk-js
npm install --save-dev @types/node // save Node.js dev dependencies
npm run build // build the sdk
npm login
npm publish --access public |
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. When prompted for a description, enter “Apache Flink Stateful Functions, version X”.
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 Apache Flink Stateful Functions ${RELEASE_VERSION}" \
|
...
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-statefun-docs-master
butflink-statefun-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-statefun-1.2.3-source-release.tar.gz.asc flink-statefun-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] Apache Flink Stateful Functions 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 Stateful Functions,
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) Stateful Functions canonical source distribution, to be deployed to the release repository at dist.apache.org
b) Stateful Functions Python SDK distributions to be deployed to PyPI
c) Maven artifacts to be deployed to the Maven Central Repository
d) Dockerfiles for new images to be deployed to Docker Hub
**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]
* All artifacts for c) can be found at the Apache Nexus Repository [3]
* PR for new Dockerfiles for this release [4]
All artifacts are signed with the key FFFFFFFFFFFFFFFFFFFFFF [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 Stateful Functions 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] link
[4] link
[5] https://dist.apache.org/repos/dist/release/flink/KEYS
[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.
Code Block | ||
---|---|---|
| ||
From: Release Manager
To: dev@flink.apache.org
Subject: [RESULT] [VOTE] Apache Flink Stateful Functions 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:
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 | ||
---|---|---|
| ||
$ svn checkout https://dist.apache.org/repos/dist/dev/flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} \ $ cd https://dist.apache.org/repos/dist/release/flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} $ twine upload --repository-url |
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://uploaddist.pypiapache.org/repos/dist/legacydev/flink \--depth=immediates cd flink svn remove apache-flink-statefun-${RELEASE_VERSION}.tar.gz apache-flink-${RELEASE_VERSION}.tar.gz.asc \ apache_flink_statefun-${RELEASE_VERSION}-py3-none-any.whl apache_flink_statefun--rc* svn commit -m "Remove old release candidates for Apache Flink Stateful Functions ${RELEASE_VERSION}-py3-none-any.whl.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.
...
" |
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: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
Remove old release candidates from dist.apache.org
...
.
Code Block language
...
bash svn remove flink-statefun-<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:
Code Block |
---|
git tag -s "release-${RELEASE_VERSION} |
...
" refs/tags/${TAG} -m " |
...
Release Stateful Functions ${RELEASE_VERSION |
...
}" |
For the GoLang SDK we we also need to push another release tag
Code Block |
---|
git tag -s "statefun-sdk-go/v${RELEASE_VERSION}" refs/tags/${TAG} -m "Release Stateful Functions ${RELEASE_VERSION}" |
Don't forget to push the tags via
Code Block |
---|
git push <remote> refs/tags/release-${RELEASE_VERSION}
git push <remote> refs/tags/statefun-sdk-go/v${RELEASE_VERSION} |
Delete the RC tags on the remote repository
Code Block |
---|
git push --delete <remote> refs/tags/${TAG}
git push --delete <remote> refs/tags/statefun-sdk-go/v${RELEASE_VERSION}-rc${RC_NUM |
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-statefun-<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:
} |
Mark the version as released in JIRA
...
Follow the instructions in the flink-statefun-docker repo to build the new Dockerfiles and send an updated manifest to Docker Hub so the new images are built and publishedthe flink-statefun-docker repo to build the new Dockerfiles and send an updated manifest to Docker Hub so the new images are built and published.
Update flink-statefun-playground (for major/minor releases only)
Create a new release-${SHORT_RELEASE_VERSION}
branch in flink-statefun-playground by forking the dev branch.
Make sure that all statefun versions are updated to the new ${SHORT_RELEASE_VERSION}
(grep for occurrences of the old version).
Checklist to proceed to the next step
- Python artifacts released and indexed in the PyPI Repository
- JavaScript artifacts released and indexed in the npm 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
- Dockerfiles in flink-statefun-docker updated for the new release and pull request opened on the Docker official-images with an updated manifestthe new images have been pushed to Dockerhub
- flink-statefun-playground contains a new release branch with updated versions (if major/minor release)
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.
...