...
The following sections assume that the release_utils
branch from https://github.com/apache/flink-connector-shared-utils/blob/release_utils/README.md is mounted as a git submodule under tools/releasing/shared
. See the README for details.
...
- verify the tag exists on GitHub, containing the release version and release candidate number
- verify that the source artifacts on https://dist.apache.org/repos/dist/dev/flink exist
- verify that the jar artifacts on https://repository.apache.org/ contain a .pom and .jar file for each module.each module.
Close the staging repository on Apache Nexus.
Review Release Notes in JIRA
JIRA automatically generates Release Notes based on the Fix Version
field applied to issues. Release Notes are intended for Flink 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").
Content of Release Notes field from JIRA tickets
To get the list of "release notes" field from JIRA, you can ran the following script using JIRA REST API (notes the maxResults limits the number of entries):
Code Block |
---|
curl -s https://issues.apache.org/jira//rest/api/2/search?maxResults=200&jql=project%20%3D%20FLINK%20AND%20%22Release%20Note%22%20is%20not%20EMPTY%20and%20fixVersion%20%3D%20${RELEASE_VERSION} | jq '.issues[]|.key,.fields.summary,.fields.customfield_12310192' | paste - - -
|
jq
is present in most Linux distributions and on MacOS can be installed via brewClose the staging repository on Apache Nexus.
Propose a pull request for website updates
...
Code Block |
---|
echo " From: Release Manager To: announce@apache.org, user@flink.apache.org, dev@flink.apache.org Reply-To: user@flink.apache.org Subject: [ANNOUNCE] Apache flink-connector-<connector> ${NEW_VERSION} released The Apache Flink community is very happy to announce the release of Apache flink-connector-<connector> ${NEW_VERSION}. Apache Flink® is an open-source stream processing framework for distributed, high-performing, always-available, and accurate data streaming applications. The release is available for download at: https://flink.apache.org/downloads.html The full release notes are available in Jira: <jira release notes link> We would like to thank all contributors of the Apache Flink community who made this release possible! Regards, Release Manager " |
...