Page History

...

Introduction

The Apache Flink project periodically declares and publishes releases. A release is one or more packages of the project artifact(s) that are approved for general public distribution and use. They may come with various degrees of caveat regarding their perceived quality and potential for change, such as “alpha”, “beta”, “incubating”, “stable”, etc.

...

Now, add your Apache GPG key to the Flink’s KEYS file in 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.)  PMC member can refer following scripts to add your Apache GPG key to the KEYS in the release repository.

wgetsvn co https://dist.apache.org/repos/dist/release/flink/KEYS -O NEW_KEYS  flink-dist-release-repo
cd flink-dist-release-repo
(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 ci -m "[flink] Add <YOUR_NAME>'s public key"

...

The following sections assume that the release_utils branch from flink-connector-shared-utils is mounted as a git submodule under tools/releasing/shared. See the README for details.

Prepare environment

, you can update the submodule by running  `git submodule update --remote` to use latest release utils, you need to mount the  flink-connector-shared-utils  as a submodule under the tools/releasing/shared if it hasn't been mounted in the connector repository. See the README for details.

Prepare environment

Check out the commit from which you intend to create the release, and run these commands Check out the commit from which you intend to create the release, and run these commands in the root directory of the connector repo:

...

• 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.

# verify the environment contains all software needed for the release process
./tools/releasing/shared/check_environment.sh

# update the versions in the poms
./tools/releasing/shared/update_branch_version.sh

# create and stage artifacts to be voted on
./tools/releasing/shared/release_git_tag.sh
./tools/releasing/shared/stage_source_release.sh

# call this once for each supported (minor) Flink version
FLINK_VERSION=1.16.0 ./tools/releasing/shared/stage_jars.sh

...

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 

...

In JIRA, inside version management, hover over the current release and a settings menu will appear. Click Release, and select today’s date.

Update and properly integrate the connector documentation in the Flink documentation

1. Make sure that in the correct Flink release branch (e.g. release-1.19, release-1.18 etc) in https://github.com/apache/flink/blob/master/docs/setup_docs.sh#L45-L57 there's a line that shows:

   Code Block
   integrate_connector_docs yourConnectorRepoName yourReleasedConnectorBranch

   When the documentation is being build, it will also download the documentation from the connector repository from the specified branch, so that it will be integrated into the Flink documentation

2. Make sure that the file in docs/data/yourConnector.yml is been updated properly (correct connector version, correct compatibility with Flink major.minor version, potential SQL variants). See https://github.com/apache/flink-connector-kafka/blob/v3.0/docs/data/kafka.yml as an example. This file is being used to determine if the Flink documentation is requested for a released Flink version, if it should display the download link for your connector (because it was released/available) or not (e.g. it's not available yet for that Flink version)

Update the nightly builds

Update .github/workflows/weekly.yml in the main  branch for the connector repository to make sure that:

1. Any potentially newly created branch is also tested in the weekly test and mapped to the Flink versions that it should be tested against
2. Remove any no longer supported connector branches and/or Flink versions

Checklist to proceed to the next step

...