druid/distribution/asf-release-process-guide.md

Getting Started

Announce intention to release

First up in performing an official release of Apache Druid is to announce in the dev mailing list, dev@druid.apache.org, that it is about time for the next (approximately) quarterly release, or, that there is a critical bug that warrants doing a bug fix release, whatever the reason happens to be. Check for any critical bugs that are still open, or issues or PRs tagged with the release milestone, and give the community a bit of heads up to try and wrap up anything that needs to be in the next release.

Create a release branch

Next up is creating the release branch off of master (or the previous release branch for a bug fix release). Be sure to do this from the apache git repo, not your fork. Name the branch for the release version that is being created, omitting the druid prefix that will appear on the release candidate and release tags:

$ git checkout origin/0.17.0
...
$ git checkout -b 0.17.1

$ git checkout origin/master
...
$ git checkout -b 0.17.0

Preparing the release branch

Ensure that the web console and docker-compose file are in the correct state in the release branch.

package.json and package-lock.json should match the release version. If they do not, run:

npm version 0.17.0

unified-console.html, Javascript script tag must match the package.json version:

<script src="public/web-console-0.17.0.js"></script>

links.ts needs to be adjusted from 'latest' to the release version:

const DRUID_DOCS_VERSION = '0.17.0';

The sample docker-compose.yml used in the Docker quickstart documentation should match the release version:

...
  coordinator:
    image: apache/druid:0.17.0
    container_name: coordinator
...

Once everything is ready, then push the branch to origin.

Preparing the master branch for the next version after branching

If doing a quarterly release, it will also be necessary to prepare master for the release after the release you are working on, by setting the version to the next release snapshot:

$ mvn versions:set -DnewVersion=0.18.0-SNAPSHOT

You should also prepare the web-console for the next release, by bumping the package.json and package-lock.json version:

npm version 0.18.0

which will update package.json and package-lock.json.

You will also need to manually update the top level html file, unified-console.html, to ensure that the Javascript script tag is set to match the package.json version:

<script src="public/web-console-0.18.0.js"></script>

DRUID_DOCS_VERSION in links.ts should already be set to 'latest' in the master branch, and so should not have to be adjusted.

The sample docker-compose.yml used in the Docker quickstart documentation should be updated to reflect the version for the next release:

...
  coordinator:
    image: apache/druid:0.18.0
    container_name: coordinator
...

Once this is completed, open a PR to the master branch. Also, be sure to confirm that these versions are all correct in the release branch, otherwise fix them and open a backport PR to the release branch.

Updating redirect links in the docs

For docs, please make sure to add any relevant redirects in website/redirects.json. This has to be done before building the new website.

Release branch hygiene

The only additions to the release branch after branching should be bug fixes, which should be back-ported from the master branch, via a second PR, not with a direct PR to the release branch. Bug fix release branches may be initially populated via cherry-picking, but it is recommended to leave at least 1 commit to do as a backport PR in order to run through CI. (Note that CI is sometimes flaky for older branches).

Once all issues and PRs that are still tagged with the release milestone have been merged, closed, or removed from the milestone, the next step is to put together a release candidate.

Initial setup to create a release candidate

SVN access

Make sure that you have Apache SVN access set up, as several steps in the release process will require you to make SVN commits.

GPG key

First, make sure you've set up a GPG key according to ASF instructions: https://www.apache.org/dev/openpgp.html

Key propagation

The Apache guide suggests using the MIT keyserver, but if there are availability issues consider using https://sks-keyservers.net/ or http://pgp.surfnet.nl/

After your key has been propagated to public key servers, add your key fingerprint as your OpenPGP Public Key Primary Fingerprint at https://id.apache.org.

The key fingerprint can be seen with gpg --list-keys, e.g.:

...
pub   rsa4096 2019-02-28 [SC]
      0495E031C35D132479C241EC9283C4921AC4483E
uid           [ultimate] Jonathan Wei (CODE SIGNING KEY) <jonwei@apache.org>
sub   rsa4096 2019-02-28 [E]
...

0495E031C35D132479C241EC9283C4921AC4483E is the fingerprint in the example above.

If all goes well, your Apache account will be associated with that key, which you can check at https://people.apache.org/committer-index.html

You will also need to add your key to our project KEYS file: https://dist.apache.org/repos/dist/release/druid/KEYS, this repo can be pulled with:

$ svn co https://dist.apache.org/repos/dist/release/druid

Add your entry to the file and commit:

$ svn commit -m 'add key for jonwei@apache.org'

Maven credentials

You'll need to configure Maven with your Apache credentials by adding the following to ~/.m2/settings.xml. Encrypt the password you store here, see https://maven.apache.org/guides/mini/guide-encryption.html for details.

<settings>
 <servers>
   <!-- To publish a snapshot of some part of Maven -->
   <server>
     <id>apache.snapshots.https</id>
     <username>your-apache-username</username>
     <password>{your-encrypted-password}</password>
   </server>
   <!-- To stage a release of some part of Maven -->
   <server>
     <id>apache.releases.https</id>
     <username>your-apache-username</username>
     <password>{your-encrypted-password}</password>
   </server>
 </servers>
</settings>

LICENSE and NOTICE handling

Before cutting a release candidate, the release manager should ensure that the contents of our LICENSE and NOTICE files are up-to-date. You should specifically check that copyright YEAR is updated in the NOTICE file.

The following links are helpful for understanding Apache's third-party licensing policies:

http://www.apache.org/dev/licensing-howto.html http://www.apache.org/legal/src-headers.html http://www.apache.org/legal/resolved.html

There are in effect 2 versions of the LICENSE and NOTICE file needed to perform a release, one set for the official ASF source release which are the actual LICENSE and NOTICE file in the root directory, and second for the convenience binary release which includes all of Druid's dependencies which we synthesize using some tools we have developed over the initial set of releases.

licenses.yaml

At the core of these tools is a dependency registry file, licenses.yaml, that lives at the project root. licenses.yaml is a global registry of all dependencies which are bundled with an official ASF source release or convenience binary release, divided into 'modules' in the following manner:

'module'	description
SOURCE/JAVA-CORE	Source level inclusions in the core Druid codebase
SOURCE/WEB-CONSOLE	Source level inclusions in the various web consoles
BINARY/JAVA-CORE	Bundled binary-only dependencies for core Druid components (i.e., not an extension, not a hadoop-dependency, not web console stuff)
BINARY/WEB-CONSOLE	Bundled binary-only dependencies for the various web consoles
BINARY/HADOOP-CLIENT	Bundled binary-only dependencies contained in the hadoop-client directory
BINARY/EXTENSIONS/{extension-name}	Bundled binary-only dependencies for Druid extensions

licenses.yaml contains both LICENSE and (relevant) NOTICE file content which is used at distribution packaging time to build a LICENSE.BINARY and NOTICE.BINARY for the binary package.

If the dependency requires it, copy any licenses to the licenses/src or licenses/bin folder.

LICENSE.BINARY and NOTICE.BINARY generator tools

tool	description
generate-binary-license	This script is run automatically when building the distribution package to generate a LICENSE.BINARY file from licenses.yaml which is renamed to LICENSE in the binary package.
generate-binary-notice	This script is run automatically when building the distribution package, and generates a NOTICE.BINARY file by appending the notice content of licenses.yaml to the source NOTICE file. This script does not currently verify that all notices that need to be are present and correct, this must currently be done manually at release time if not done in the PR that changed a dependency.
web-console/licenses	Updates licenses.yaml with all Druid of the licenses used by the Druid web-console 'binary'.

Additional tools

These additional tools were largely used to bootstrap the initial LICENSE, LICENSE.BINARY, NOTICE, and NOTICE.BINARY for our very first ASF releases and collect all the information we needed to eventually create licenses.yaml, and may still prove useful from time to time.

tool	description
generate-license-dependency-reports	Point this to the Druid source root, and give it the location of a temp scratch directory, and it will output Maven dependency reports for Druid. (I believe I had to generate Maven dep report separately for hadoop-client)
check-licenses	Checks licenses.yaml against the output of generate-license-dependency-reports.py, used by travis and -Papache-release when building distribution, to verify that all dependencies are present and match the versions in licenses.yaml.
jar-notice-lister	Point this to an extracted Druid binary distribution, and give it a temp scratch directory, and it will output NOTICE information for all the Druid JAR files.

The licenses.yaml dependency registry serves to help ease the process of managing releases and maintaining LICENSE and NOTICE compliance for a project as complex and with as many dependencies as Druid.

Release notes

It is also the release managers responsibility for correctly assigning all PRs merged since the previous release with a milestone in github, as well as crafting the release notes. This is largely a manual process, but we have a couple of tools which can assist to some degree.

tool	description
get-milestone-contributors	lists github users who contributed to a milestone
get-milestone-prs	lists PRs between tags or commits and the milestone associated with them.
tag-missing-milestones	Find pull requests which the milestone is missing and tag them properly.
find-missing-backports	Find PRs which have been back-ported to one release branch but not another. Useful if a bug fix release based on the previous release is required during a release cycle.
make-linkable-release-notes	given input of a version, input markdown file path, and output markdown file path, will rewrite markdown headers of the input file to have embedded links in the release notes style.

Next create an issue in the Druid github to contain the release notes and allow the community to provide feedback prior to the release. Make sure to attach it to the release milestone in github. It is highly recommended to review previous release notes for reference of how to best structure them. Be sure to call out any exciting new features, important bug fixes, and any compatibility concerns for users or operators to consider when upgrading to this release.

The make-linkable-release-notes script can assist in converting plain markdown into a version with headers that have embedded self links, to allow directly linking to specific release note entries.

Building a release candidate

Update the release branch to have all commits needed

The release branch should have all commits merged before you create a tag. A commit must be in the release branch if

1. it is merged into the master branch before the release branch is created. In this case, the PR corresponding to the commit might not have the milestone tagged. The tag-missing-milestones script can be useful to find such PRs and tag them properly. See the above Release notes section for more details about the script.
2. it is merged into the master branch after the release branch is created and tagged with the release version. In this case, the commit must be backported to the release branch. The find-missing-backports script can be used to find such commits that have not been backported. Note that this script relies on the milestone tagged in the PR, so PRs must be tagged properly to make this script working. See the above Release notes section for more details about the script.

Set version and make a tag

Once the release branch is good for an RC, you can build a new tag with:

$ mvn -Pwebsite-docs -DreleaseVersion=0.17.0 -DdevelopmentVersion=0.18.0-SNAPSHOT -Dtag=druid-0.17.0-rc3 -DpushChanges=false clean release:clean release:prepare

In this example it will create a tag, druid-0.17.0-rc3. If this release passes vote then we can add the final druid-0.17.0 release tag later. We added website-docs profile, because otherwise, website module is not updated with rc version. If you want to skip tests, you can do so with following command

$ mvn -DreleaseVersion=0.17.0 -DdevelopmentVersion=0.18.0-SNAPSHOT -Dtag=druid-0.17.0-rc3 -DpushChanges=false -DskipTests -Darguments=-DskipTests clean release:clean release:prepare

Retain the release.properties file! You will need it when uploading the Maven artifacts for the final release.

Do a clean clone (so the source distribution does not pick up extra files)

$ git clone git@github.com:apache/druid.git druid-release

Switch to tag

$ git checkout druid-0.17.0-rc3

Build Artifacts

$ mvn clean install -Papache-release,dist,rat -DskipTests -Dgpg.keyname=<your GPG key fingerprint>

This should produce the following artifacts:

apache-druid-0.17.0-bin.tar.gz
apache-druid-0.17.0-bin.tar.gz.asc
apache-druid-0.17.0-bin.tar.gz.sha512
apache-druid-0.17.0-src.tar.gz
apache-druid-0.17.0-src.tar.gz.asc
apache-druid-0.17.0-src.tar.gz.sha512

Ensure that the GPG key fingerprint used in the mvn install command matches your release signing key in https://dist.apache.org/repos/dist/release/druid/KEYS.

Verify checksums

$ diff <(shasum -a512 apache-druid-0.17.0-bin.tar.gz | cut -d ' ' -f1) <(cat apache-druid-0.17.0-bin.tar.gz.sha512 ; echo)
...
$ diff <(shasum -a512 apache-druid-0.17.0-src.tar.gz | cut -d ' ' -f1) <(cat apache-druid-0.17.0-src.tar.gz.sha512 ; echo)

Verify GPG signatures

$ gpg --verify apache-druid-0.17.0-bin.tar.gz.asc apache-druid-0.17.0-bin.tar.gz
...
$ gpg --verify apache-druid-0.17.0-src.tar.gz.asc apache-druid-0.17.0-src.tar.gz

Commit artifacts to SVN repo

Checkout the dist/dev repo and add a directory for the new release candidate. The KEYS file in this repo is obsoleted and should not be used.

$ svn checkout https://dist.apache.org/repos/dist/dev/druid

Copy the src and bin artifacts to a folder for the release version and add it to SVN and publish the artifacts:

$ svn add 0.17.0-rc3
...
$ svn commit -m 'add 0.17.0-rc3 artifacts'

Update druid.staged.apache.org

1. Pull https://github.com/apache/druid-website and https://github.com/apache/druid-website-src. These repositories should be in the same directory as your Druid repository that should have the release tag checked out.

2. From druid-website, checkout branch asf-staging.

3. From druid-website-src, create a release branch from master and run ./release.sh 0.17.0 0.17.0, replacing 0.17.0 where the first argument is the release version and 2nd argument is commit-ish. This script will:

• checkout the tag of the Druid release version
• build the docs for that version into druid-website-src
• build druid-website-src into druid-website
• stage druid-website-src and druid-website repositories to git.

4. Make a PR to the src repo (https://github.com/apache/druid-website-src) for the release branch, such as 0.17.0-docs.

5. Make another PR to the website repo (https://github.com/apache/druid-website) for the asf-staging branch. Once the website PR is pushed to asf-staging, https://druid.staged.apache.org/ will be updated near immediately with the new docs.

Create staged Maven repo

Before opening the release vote thread, we create a staged maven repository containing the RC artifacts.

You can generate a staged maven repo for the RC with the following steps:

• Copy the release.properties that was generated when the RC tag was created back to your repo root (You'll need to change scm.tag in that file to match the specific rc tag you created if you did not specify -Dtag when creating the release). If you still have the working copy that build the tag available, you may use that.
• Run mvn release:perform

This will create a staged Maven repo here (login with Apache credentials): https://repository.apache.org/#stagingRepositories

To make the staged repo publicly accessible, "Close" the staging repo.

Release candidates and voting

Release votes are held on the dev mailing list, dev@druid.apache.org. Druid PMC votes are binding.

You can use the following template for the release vote thread, replacing values as necessary.

Subject

[VOTE] Release Apache Druid 0.17.0 [RC3]

Body

Hi all,

I have created a build for Apache Druid 0.17.0, release
candidate 3.

Thanks for everyone who has helped contribute to the release! You can read
the proposed release notes here:
https://github.com/apache/druid/issues/9066

The release candidate has been tagged in GitHub as
druid-0.17.0-rc3 (54d29e438a4df34d75e2385af6cefd1092c4ebb3),
available here:
https://github.com/apache/druid/releases/tag/druid-0.17.0-rc3

The artifacts to be voted on are located here:
https://dist.apache.org/repos/dist/dev/druid/0.17.0-rc3/

A staged Maven repository is available for review at:
https://repository.apache.org/content/repositories/orgapachedruid-1016/

Staged druid.apache.org website documentation is available here:
https://druid.staged.apache.org/docs/0.17.0/design/index.html

A Docker image containing the binary of the release candidate can be
retrieved via:
docker pull apache/druid:0.17.0-rc3

artifact checksums
src:
1f25c55e83069cf7071a97c1e0d56732437dbac4ef373ed1ed72b5b618021b74c107269642226e80081354c8da2e92dc26f1541b01072a4720fd6cfe8dc161a8
bin:
0c4b71f077e28d2f4d3bc3f072543374570b98ec6a1918a5e1828e1da7e3871b5efb04070a8bcdbc172a817e43254640ce28a99757984be7d8dd3d607f1d870e
docker: df9b900d3726ce123a5c054768da1ea08eba6efe635ced5abc3ad72d6c835e2c

Release artifacts are signed with the following key:
https://people.apache.org/keys/committer/cwylie.asc

This key and the key of other committers can also be found in the project's
KEYS file here:
https://dist.apache.org/repos/dist/release/druid/KEYS

(If you are a committer, please feel free to add your own key to that file
by following the instructions in the file's header.)


Verify checksums:
diff <(shasum -a512 apache-druid-0.17.0-src.tar.gz | \
cut -d ' ' -f1) \
<(cat apache-druid-0.17.0-src.tar.gz.sha512 ; echo)

diff <(shasum -a512 apache-druid-0.17.0-bin.tar.gz | \
cut -d ' ' -f1) \
<(cat apache-druid-0.17.0-bin.tar.gz.sha512 ; echo)

Verify signatures:
gpg --verify apache-druid-0.17.0-src.tar.gz.asc \
apache-druid-0.17.0-src.tar.gz

gpg --verify apache-druid-0.17.0-bin.tar.gz.asc \
apache-druid-0.17.0-bin.tar.gz

Please review the proposed artifacts and vote. Note that Apache has
specific requirements that must be met before +1 binding votes can be cast
by PMC members. Please refer to the policy at
http://www.apache.org/legal/release-policy.html#policy for more details.

As part of the validation process, the release artifacts can be generated
from source by running:
mvn clean install -Papache-release,dist -Dgpg.skip

The RAT license check can be run from source by:
mvn apache-rat:check -Prat

This vote will be open for at least 72 hours. The vote will pass if a
majority of at least three +1 PMC votes are cast.

[ ] +1 Release this package as Apache Druid 0.17.0
[ ] 0 I don't feel strongly about it, but I'm okay with the release
[ ] -1 Do not release this package because...

Thanks!

Anyone can vote on a release. When voting, you should list out what exactly you checked and note whether or not your vote is binding. (It is binding if you are on the Druid PMC, otherwise it is non-binding.) A sample vote would look like:

+1 (binding)

- Proper NOTICE, LICENSE, DISCLAIMER files are present in both src and bin packages.
- Verified .asc signatures and .sha512 checksums of both src and bin packages.
- Source tarball git.version file is present and correct.
- Source tarball builds and tests pass.
- Ran through quickstart on binary tarball.

If you find something wrong with a release that should block it, vote -1 and explain why. For example:

-1, because the src tarball appears to accidentally have binary jar files in it:

- foo.jar
- bar.jar

According to Apache release policy,

• Release votes should remain open for at least 72 hours.
• Release votes pass if a minimum of three positive votes, and more positive than negative votes, are cast.
• Releases may not be vetoed.
• Before casting +1 binding votes, individuals are required to download all signed source code packages onto their own hardware, verify that they meet all requirements of ASF policy, validate all cryptographic signatures, compile as provided, and test the result on their own platform.

Druid PMC vote result

Once the Druid community vote passes (or fails), close the vote with a thread like the following:

Subject

[RESULT][VOTE] Release Apache Druid 0.17.0 [RC3]

Body

Thanks to everyone who participated in the vote! The results are as follows:

Clint Wylie: +1 (non-binding)
Jihoon Son: +1 (binding)
Furkan KAMACI: +1 (non-binding)
Julian Hyde: +1 (binding)
David Lim: +1 (binding)
Surekha Saharan: +1 (non-binding)

...

Cancelling a vote

If for any reason during the Druid PMC vote a blocking issue becomes apparent, a vote should be officially cancelled by sending an email with the following subject line: [CANCEL][VOTE] Release Apache Druid 0.17.0 [RC3] and the reasons for the cancellation in the body.

Previous vote threads for additional examples

• Druid PMC

Final Release

Once a release candidate has passed the Druid PMC vote, you'll need to do the following:

• Close the Druid PMC vote thread as described above
• Publish release artifacts to the release SVN repo
• Publish the staged Maven repo
• Wait 24 hours to allow the artifacts to propagate across mirrors
• Update the druid.apache.org website
• Announce the release

Create git tag

Tag the rc that passed vote as the release tag and push to github.

$ git checkout druid-0.17.0-rc3
$ git tag druid-0.17.0
$ git push origin/druid-0.17.0

Publish release artifacts to SVN

The final release artifacts are kept in the https://dist.apache.org/repos/dist/release/druid repo (same as KEYS).

Use svn mv to publish the release artifacts as below:

$ svn mv https://dist.apache.org/repos/dist/dev/druid/0.17.0-rc3 https://dist.apache.org/repos/dist/release/druid/0.17.0 -m 'add 0.17.0 artifacts'

Replace the versions of the release candidate and the release with the ones you are currently working on. This command will drop those artifacts from the dev repo but add them to the release repo. Once the svn mv command succeeds, you should be able to see the release artifacts in https://dist.apache.org/repos/dist/release/druid/0.17.0.

Publish the staged Maven repo

Returning to the staged repo you created for the Druid PMC vote ( https://repository.apache.org/#stagingRepositories), "Release" the repo to publish the Maven artifacts.

https://central.sonatype.org/pages/releasing-the-deployment.html#close-and-drop-or-release-your-staging-repository

Wait 24 hours

Apache policy requires projects to wait at least 24 hours after uploading artifacts before announcing a release, to allow time for the release artifacts to propagate across mirrors.

http://www.apache.org/legal/release-policy.html#release-announcements

Update druid.apache.org

1. Pull https://github.com/apache/druid-website and https://github.com/apache/druid-website-src. These repositories should be in the same directory as your Druid repository that should have the release tag checked out.

2. To update the downloads page of the website, update the _config.yml file in the root of the website src repo. Versions are grouped by release branch:

druid_versions:
  - release: 0.16
    versions:
      - version: 0.16.0-incubating
        date: 2019-09-24
  - release: 0.15
    versions:
      - version: 0.15.1-incubating
        date: 2019-08-15

3. From druid-website, checkout branch asf-site.

4. From druid-website-src, checkout the branch you created to update the staged Druid website.

5. From druid-website-src, run ./release.sh 0.17.0 0.17.0, replacing 0.17.0 where the first argument is the release version and 2nd argument is commit-ish. This script will:

• checkout the tag of the Druid release version
• build the docs for that version into druid-website-src
• build druid-website-src into druid-website
• stage druid-website-src and druid-website repositories to git.

6. Make a PR to the src repo (https://github.com/apache/druid-website-src) for the master branch.

7. Make a PR to the website repo (https://github.com/apache/druid-website) for the asf-site branch. Once the website PR is merged, https://druid.apache.org/ will be updated immediately.

Draft a release on github

Copy the release notes and create the release from the tag.

Announce the release

Announce the release to all the lists, announce@apache.org, dev@druid.apache.org, druid-user@googlegroups.com (general announcement list, druid dev list, druid user group).

Additionally, announce it to the Druid official ASF Slack channel, https://druid.apache.org/community/join-slack.

subject

[ANNOUNCE] Apache Druid 0.17.0 release

body

The Apache Druid team is proud to announce the release of Apache Druid 0.17.0. 
Druid is a high performance analytics data store for event-driven data.

Apache Druid 0.17.0 contains over 350 new features, performance
enhancements, bug fixes, and major documentation improvements from 50
contributors. Major new features and improvements include:

- 'Vectorized' query processing
- 'Minor' compaction
- Native parallel indexing with shuffle
- New 'indexer' process
- Huge improvements to the web console
- New documentation website
- Official Docker image

Source and binary distributions can be downloaded from:
https://druid.apache.org/downloads.html

Release notes are at:
https://github.com/apache/druid/releases/tag/druid-0.17.0

A big thank you to all the contributors in this milestone release!

Previous release announcements

Sticky the announcement on the 'druid-user' group.

Update Wikipedia

Update the release version and date on the Apache Druid Wikipedia article (bots might also do this?).

Remove old releases which are not 'active'

Removing old releases from the 'release' SVN repository which are not actively being developed is an Apache policy. The contents of this directory controls which artifacts are available on the Apache download mirror network. All other releases are available from the Apache archives, so removal from here is not a permanent deletion.

We consider the 'active' releases to be the latest versions of the current and previous quarterly releases. If you are adding a new quarterly release, remove the oldest quarterly release. If you are adding a bug fix release, remove the current quarterly release.

For example, if the new release is a bug fix, 0.18.1, and the current versions are 0.18.0, and 0.17.1, then you would delete 0.18.0, leaving 0.18.1 and 0.17.1 on the mirrors. If instead we were adding 0.19.0, the resulting set of 'active' releases would be 0.19.0 and 0.18.0.