...
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_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
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> |
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.
...
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 |
...
Code Block | ||
---|---|---|
| ||
RELEASE_VERSION=$RELEASE_VERSION RELEASE_CANDIDATE=$RC_NUM tools/releasing/create_release_branch.sh |
Tag the release commit:
OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION tools/releasing/update_branch_version.sh |
Tag the release commit:
Code Block |
---|
git tag |
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:
...
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
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:
(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
) 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.
...
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-${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 ask the PMC for the login credentials to the npmflink
account on npm. With these credentials it is possible to publish the JavaScript SDK by using npm.
Code Block | ||||
---|---|---|---|---|
| ||||
npm login
cd flink-statefun/statefun-sdk-js
npm publish |
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.
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}" \
https://dist.apache.org/repos/dist/dev/flink/flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} \
https://dist.apache.org/repos/dist/release/flink/flink-statefun-${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 | ||||
Code Block | ||||
$ svn move -m "Release Flink ${RELEASE_VERSION}" \ https://dist.apache.org/repos/dist/dev/flink/flink --depth=immediates cd flink svn remove flink-statefun-${RELEASE_VERSION}-rc${RC_NUM} \ https://dist.apache.org/repos/dist/release/flink/flink-statefun-rc* svn commit -m "Remove old release candidates for Apache Flink Stateful Functions ${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:
...
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-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.
...