THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Each release is executed by a Release Manager, who needs to be a Apache Flink committer and is selected among the 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.
...
- 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
- Update flink-shaded dependencies in other repositories
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.
...
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:
| Code Block | ||
|---|---|---|
| ||
gpg --list-keys |
This will list your GPG keys. One of these should reflect your Apache account, for example:There was a change being made to the way how the flink-shaded releases are organized within git due to the fact that bugfix releases happen quite rarely. Changes were only performed on master. x.0 releases would be created by tagging the relevant commit on the master branch. This was done to reduce unnecessary effort. If it comes to a point where a bugfix release becomes necessary, one should go ahead and create a release branch release-x.0 (to match the naming scheme of the past branches) which should be based on the tag with the same name release-x.0.
| Info |
|---|
Branches are prefered by git in case of name collisions, i.e. |
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:
| Code Block | ||
|---|---|---|
| ||
gpg --list-keys |
This will list your GPG keys. One of these should reflect your Apache account, for example:| Code Block | ||
|---|---|---|
| ||
-- | ||
| Code Block | ||
| ||
----------------------------------------------------------------------- pub 2048R/845E6689 2016-02-23 uid Nomen Nescio <anonymous@apache.org> sub 2048R/BA4D50BE 2016-02-23 |
...
Now, add your Apache GPG key to the Flink’s KEYS file both in dev and release repositories 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.)assistance.) PMC member can refer following scripts to add your Apache GPG key to the KEYS in the release repository.
| Code Block | ||
|---|---|---|
| ||
wget https://dist.apache.org/repos/dist/release/flink/KEYS -O NEW_KEYS
(gpg --list-sigs <YOUR_KEY_ID> && gpg --armor --export <YOUR_KEY_ID>) >> ~/NEW_KEYS
svn co https://dist.apache.org/repos/dist/release/flink flink-dist-release
cd flink-dist-release
cp ../NEW_KEYS 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:
...
- Create the source release archive
- Deploy jar artifacts to the Apache Nexus Repository, which is the staging area for deploying the jars to Maven Central
- Note: Please do not use VPN or change your IP address when stage artifacts to Apache Nexus Repository, it may lead to multiple staging repositories which is unexpected.
| Code Block | ||
|---|---|---|
| ||
# tag release commit
git tag -s ${TAG} -m "${TAG}"
# create source release
cd ${FLINK_SHADED_DIR}/tools
RELEASE_VERSION=$RELEASE_VERSION releasing/create_source_release.sh
# stage maven artifacts
cd ${FLINK_SHADED_DIR}/tools
releasing/deploy_staging_jars.sh
cd ${FLINK_SHADED_DIR} |
...
The final step of building the candidate is to propose a website pull request.
- The
docs/data/additional_
...
components.yml
...
- must be updated to contain the new release:
...
- you there need to update the source source_release_url, source_release_asc_url and source_release_sha512_url in
flink-shaded Add a new entry to
docs/data/release_archive
...
.ymlunderflink_shaded. You will need to add the version and release_date. The release_date is the date you make today, but needs to be updated to the actual release date when the release is official completed.
Do NOT update the "Pre-bundled hadoop" entries for the main Flink releases.
...
Use reporter.apache.org to seed the information about the release into future project reports.
Checklist to declare the process completed
...
.
Checklist to declare the process completed
- Website pull request to list the release merged
- Release recorded in reporter.apache.org.
- Release announced on the dev@ mailing list.
- Prepare for the next development iteration by creating/merging a PR bumping the flink-shaded version (e.g. 725c0caf3ab)
Update flink-shaded dependency in other repositories
Repositories that have the flink-shaded dependency included and need updates (flink-shaded and shaded dependency versions):
...
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.
...