Creating a Paimon Release

This is based on the release guide of the Apache Beam project: https://beam.apache.org/contribute/release-guide/

Introduction

The Apache Paimon project periodically declares and publishes releases.

The Paimon community treats releases with great importance. Releases are signed off by the entire Paimon community in a public vote.

Each release is executed by a Release Manager, who is selected/proposed by the Paimon PPMC 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.

Please remember that publishing software has legal consequences. This guide complements the foundation-wide Product Release Policy and Release Distribution Policy.

Overview

The release process consists of several steps:

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

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.

Anybody can propose a release on the dev@ mailing list, giving a solid argument and nominating a committer as the Release Manager (including themselves). There’s no formal process, no vote requirements, and no timing requirements. Any objections should be resolved by consensus before starting the release.

In general, the community prefers to have a rotating set of 3-5 Release Managers. Keeping a small core set of managers allows enough people to build expertise in this area and improve processes over time, without Release Managers needing to re-learn the processes for each release. That said, if you are a committer interested in serving the community in this way, please reach out to the community on the dev@ mailing list.

Checklist to proceed to the next step

Community agrees to release
Community selects a Release Manager

Prepare for the release

Before your first release, you should perform one-time configuration steps. This will set up your security keys for signing the release and access to various release repositories.

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:

gpg --list-keys

This will list your GPG keys. One of these should reflect your Apache account, for example:

--------------------------------------------------
pub   2048R/845E6689 2016-02-23
uid                  Nomen Nescio <anonymous@apache.org>
sub   2048R/BA4D50BE 2016-02-23

Here, the key ID is the 8-digit hex string in the pub line: 845E6689.

Now, add your Apache GPG key to the Paimon’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:

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:

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.paimon under Staging Profiles.
Navigate to your Profile (top right dropdown menu of the page).
Choose User Token from the dropdown, then click Access 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, where TOKEN_NAME and TOKEN_PASSWORDare your secret tokens:

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 clean install to ensure that the build processes that are specific to that profile are in good shape.

Create a release branch

Release candidates are built from a release branch. As a final step in preparation for the release, you should create the release branch, push it to the code repository (you should probably do this once the whole process is done), and update version information on the original branch.

Set up a few environment variables to simplify Maven commands that follow. (We use bash Unix syntax in this guide.)

RELEASE_VERSION="0.4.0"
SHORT_RELEASE_VERSION="0.4"
CURRENT_SNAPSHOT_VERSION="$SHORT_RELEASE_VERSION-SNAPSHOT"
NEXT_SNAPSHOT_VERSION="0.5-SNAPSHOT"
SHORT_NEXT_SNAPSHOT_VERSION="0.5"

If you are doing a new major/minor release (e.g. 0.4.0, 0.5.0), check out the version of the codebase from which you start the release. This may be HEAD of the master branch. Create a branch for the new version that we want to release before updating the master branch to the next development version:

$ git checkout master
$ 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

If you're creating a new bugfix release (e.g. 0.4.1), you will skip the above step and simply check out the the already existing branch for that version:

$ git checkout release-$SHORT_RELEASE_VERSION

If this is a major release, the newly created branch needs to be pushed to the official repository.

Next, for major releases, some configuration for our documentation builds needs to be manually updated, in the docs/config.toml file:, as listed below.

baseURL = '//paimon.apache.org/docs/release-$SHORT_RELEASE_VERSION'
IsStable = true
Version = "$RELEASE_VERSION"
VersionTitle = "$SHORT_RELEASE_VERSION"
Branch = "release-$SHORT_RELEASE_VERSION"
MenuLinks = [
    ["Project Homepage", "//paimon.apache.org"],
    ["JavaDocs", "//paimon.apache.org/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.

$ git checkout master

PreviousDocs = [
    ["$SHORT_RELEASE_VERSION", "https://paimon.apache.org/docs/release-$SHORT_RELEASE_VERSION"]
  ]

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.paimon listed under Staging Profiles in Nexus
Release Manager’s Nexus User Token is configured in settings.xml
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.
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 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.

NOTE: Paimon is a incubator project, for example, RELEASE_VERSION is 0.4.0-incubating.

RC_NUM="1"
TAG="release-${RELEASE_VERSION}-rc${RC_NUM}"

Now, create a candidate branch:

RELEASE_CANDIDATE=$RC_NUM tools/releasing/create_release_branch.sh

Update branch version:

$ OLD_VERSION=$CURRENT_SNAPSHOT_VERSION NEW_VERSION=$RELEASE_VERSION tools/releasing/update_branch_version.sh

Tag the release commit:

git tag -s ${TAG} -m "${TAG}"

See Telling Git about your signing key

We now need to do several things:

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

First, we build the source release:

$ RELEASE_VERSION=$RELEASE_VERSION tools/releasing/create_source_release.sh

Finally, we stage the maven artifacts:

$ 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 Paimon, 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 Paimon section of the dev repository on dist.apache.org via Subversion. In a fresh directory:
```
svn checkout hhttps://dist.apache.org/repos/dist/dev/incubator/paimon/ --depth=immediates
```

Make a directory for the new release:

mkdir paimon/paimon-${RELEASE_VERSION}-rc${RC_NUM}

Copy source distributions, hashes, and GPG signature:

mv <paimon-dir>/release/* paimon/paimon-${RELEASE_VERSION}-rc${RC_NUM}

Add and commit all the files.

cd paimon 
svn add paimon-${RELEASE_VERSION}-rc${RC_NUM}
svn commit -m "Apache Paimon, version ${RELEASE_VERSION}, release candidate ${RC_NUM}"

Verify that files are present

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
Check docs/config.toml to ensure that
- the version constants refer to the new version
- the baseurl does not point to master but 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 apache-paimon-0.4.0-incubating-src.tgz)
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.

From: Release Manager
To: dev@paimon.apache.org
Subject: [VOTE] Release Apache Paimon 0.4.0-incubating, release candidate #2

Hi everyone,

Please review and vote on the release candidate #2 for the version
0.4.0-incubating, as follows:

[ ] +1, Approve the release
[ ] -1, Do not approve the release (please provide specific comments)

The complete staging area is available for your review, which includes:

* the official Apache source release to be deployed to dist.apache.org
[1], which are signed with the key with fingerprint
2C2B6A653B07086B65E4369F7C76245E0A318150 [2],

* all artifacts to be deployed to the Maven Central Repository [3],

* source code tag "release-0.4.0-incubating-rc2" [4].

The vote will be open for at least 72 hours. It is adopted by majority
approval, with at least 3 PPMC affirmative votes.

[1] https://dist.apache.org/repos/dist/dev/incubator/paimon/paimon-0.4.0-incubating-rc2/
[2] https://dist.apache.org/repos/dist/release/incubator/paimon/KEYS
[3] https://repository.apache.org/content/repositories/orgapachepaimon-1005/
[4] https://github.com/apache/incubator-paimon/tree/release-0.4.0-incubating-rc2

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.

From: Release Manager
To: dev@paimon.apache.org
Subject: [RESULT] [VOTE] Release Apache Paimon 0.4.0-incubating, release candidate #2

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 PPMC 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 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 orgapachepaimon-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.

$ svn move -m "Release Paimon ${RELEASE_VERSION}" \
    https://dist.apache.org/repos/dist/dev/incubator/paimon/paimon-${RELEASE_VERSION}-rc${RC_NUM} \
    https://dist.apache.org/repos/dist/release/incubator/paimon/paimon-${RELEASE_VERSION}

Remove old release candidates from dist.apache.org

Remove the old release candidates from https://dist.apache.org/repos/dist/dev/incubator/paimon using Subversion.

Remove old release candidates from dist.apache.org

svn checkout https://dist.apache.org/repos/dist/dev/incubator/paimon --depth=immediates
cd paimon
svn remove paimon-${RELEASE_VERSION}-rc*
svn commit -m "Remove old release candidates for Apache Paimon ${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 Paimon section of the release repository on dist.apache.org via Subversion. In a fresh directory:
```
 svn checkout https://dist.apache.org/repos/dist/release/incubator/paimon --depth=immediates
 cd paimon
```

Remove files for outdated releases and commit the changes.

 svn remove paimon-<version_to_remove>
 svn commit -m "Remove old release for Apache Paimon ${RELEASE_VERSION_MAJOR}"

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:

git tag -s "release-${RELEASE_VERSION}" ${TAG}

Update website to point to new stable release documentation (for major releases only)

In our website repository paimon-website, for major releases we need to update the website to point to the new stable release.

Checklist to proceed to the next step

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/incubator/paimon/
Dev repository https://dist.apache.org/repos/dist/dev/incubator/paimon/ is empty
Release tagged in the source code repository
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

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.

Merge website pull request

Merge the website pull request to list the release. Make sure to regenerate the website as well, as it isn't build automatically.

Apache mailing lists

Announce on the dev@ mailing list that the release has been finished.

Announce on the release on the user@ mailing list, listing major improvements and contributions.

Announce the release on the announce@apache.org mailing list.

From: Release Manager
To: dev@paimon.apache.org, user@paimon.apache.org, announce@apache.org
Subject: [ANNOUNCE] Apache Paimon 1.2.3-incubating released

The Apache Paimon community is very happy to announce the release of Apache Paimon 1.2.3-incubating.

Documentation for Paimon can be found at:
..............

Maven artifacts for Paimon can be found at:
https://search.maven.org/search?q=g:org.apache.paimon

We would like to thank all contributors of the Apache Paimon community who made this release possible!

Regards,
Release Manager

Recordkeeping

Use reporter.apache.org to seed the information about the release into future project reports.

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.

If we have specific ideas, please start a discussion on the dev@ mailing list and/or propose a pull request to update this guide. Thanks!

Page tree

Creating a Paimon Release

Introduction

Overview

Decide to release

Checklist to proceed to the next step

Prepare for the release

One-time setup instructions

GPG Key

Access to Apache Nexus repository

Verify that a Release Build Works

Create a release branch

Checklist to proceed to the next step

Build a release candidate

Build and stage artifacts

Stage source and binary releases on dist.apache.org

Checklist to proceed to the next step

Vote on the release candidate

Checklist to proceed to the finalization step

Fix any issues

Checklist to proceed to the next step

Finalize the release

Deploy artifacts to Maven Central Repository

Deploy source and binary releases to dist.apache.org

Remove old release candidates from dist.apache.org

Remove outdated versions from dist.apache.org

Git tag

Update website to point to new stable release documentation (for major releases only)

Checklist to proceed to the next step

Promote the release

Merge website pull request

Apache mailing lists

Recordkeeping

Improve the process