This article contains all the steps required to release Apache Geode. 

Before you begin

Software dependencies

1. git →  https://git-scm.com/downloads
2. docker → https://docs.docker.com/docker-for-mac/install/ 
3. svn → [on Mac, install command line tools → https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools]
4. gpg tools → https://gpgtools.org
5. java JDK8 → https://adoptopenjdk.net Make sure you have the latest patch release of OpenJDK 1.8.0 (not Oracle JDK).
6. Homebrew (optional) → https://brew.sh/
7. fly → use platform-appropriate download link in bottom right corner of https://concourse.apachegeode-ci.info
8. cmake, doxygen, and openssl - install using an appropriate package manager, e.g. on Mac: brew install doxygen && brew install cmake && brew install openssl
9. text editor (vi or whatever you prefer)
10. web browser

Permission and keys

Minor vs Patch release

A minor release is a version x.y.0

A patch release is a version x.y.n where n > 0

Except where noted, all instructions in this guide apply to both types of releases.

Announce intent to branch (minor only)

Geode cuts support branches for new minor releases on a time-based schedule (Monday on or after Feb 1, May 1, Aug 1, Nov 1).  About a week before, send a [DISCUSS] email to dev@geode.apache.org informing developers that a new support branch is about to be created.  Remind the community that only critical fixes will be allowed once the support branch is created, so it is helpful to have develop as stable as possible before branching.

Note: patch release(s) are made only by proposal on the dev list (not on a time-based schedule), from existing support branch(es).

Review LICENSE and NOTICE files

Confirm that the Geode LICENSE and NOTICE files on develop are accurate (ask for help on the dev list if needed).  This is best done before cutting the branch, otherwise be sure to backport any changes to the support branch as well.

1. use dev-tools/release/license_review.sh -v HEAD -p 1.12.0 (replace 1.12.0 with the version of the previous release) to check the LICENSE files for missing dependencies or outdated versions and compare dependencies against a previous release.  If any dependencies were removed, manually check for stale references in LICENSE or NOTICE files that can be removed.  If new dependencies were added that have Apache 2.0 License, add them to the license_review script 's isApache2 function.

Branching for release

Create the support branches (minor only)

1. From one directory above a checkout of latest geode develop, run the create_support_branches script.  This will create branches on all projects and update version numbers appropriately, and guide you though creating the support pipeline, updating Jira, and creating a PR to bump develop to the next version.

   cd ..
   geode/dev-tools/release/create_support_branches.sh -v 1.13 -g your_github_username

2. Review the benchmark baseline on the support branch.  It should be the more recent of {previous release} or develop/highwater.  Note: as the release progresses, consider creating and using a dedicated version/highwater tag on the support branch.

   See ci/pipelines/shared/jinja.variables.yml around line 19:

    benchmarks:
      baseline_branch: develop/highwater
      baseline_version: ''
      benchmark_branch: support/{x.y}

3. Send email to dev@geode.apache.org informing the creation of the support branch and requesting feedback.

   Hello Geode Dev Community,
   
   We have created a new support branch for Apache Geode {x.y.0} - "support/{x.y}"
   
   We hope to make a final release in about a month.  Please focus your acceptance testing on this branch and raise any concerns in the next few weeks.  After some quiet period we will package a release candidate and begin voting upon it.
   
   Regards
   {Release Manager}

4. For the duration of the release process, continue to monitor the new release pipeline and address any issues that may arise, including analyzing any test failures.

Bump the version of the develop branch (minor only)

1. The create_support_branches script already walked you through creating the PR for this, adding the new version to Jira, and bumping the pipeline version on develop.  (note: you must be in the Jira Administrators group to see the Add button in Jira; request permission on the dev list if you don't see it).

2. Review the benchmark baseline on develop.  Ask on the dev list if you are unsure whether the last support branch or a highwater tag makes the most sense.

   See ci/pipelines/shared/jinja.variables.yml around line 19:

    benchmarks:
      baseline_branch: develop/highwater
      baseline_version: ''
      benchmark_branch: develop

Validate Fix Versions in JIRA

There are two parts to this audit:

1. Does every commit since the last release have a corresponding Jira ticket marked as Fixed in this version?
2. Can every Jira ticket marked as fixed in this version be traced to a commit in this support branch since the last release?

To help automate the process of identifying commits and tickets in need of review, you may find this script useful, or create your own script.

Tips:

• If a Jira ticket is fixed on develop AND cherry-picked to a support branch, it should list both fix versions.
• If a Jira ticket is fixed by way of another commit or Jira ticket, there should be a comment detailing this.
• If a Jira ticket is partially fixed but there is more work to be done in the next release, splitting into two tickets may be the best way to represent that.
• Don't forget about geode-native.  It's a separate git repository but uses GEODE Jira tickets and is released as part of Geode.
• Be mindful of revert commits
• Be mindful of Jira tickets resolved as "Won't Fix", "Duplicate" etc.
• Be mindful of Jira tickets that were re-opened, but the Fixed version was never cleared.
• For changes that came in close to the time a support branch was cut, double-check whether the fix actually made it onto the branch.  The list of release start dates can be helpful, but checkout the release tag to confirm for certain. 
• When in doubt, reach out to people that have been involved the with ticket to confirm its status.  Many times they just forgot to marked it fixed when their PR got merged, or forgot to fill in the fixed version.

Begin preparing release documentation

1. Start preparing the release docs at Release Notes. Ask the community for suggestions on fixes and features to highlight, or go through the commits yourself and choose 5-10 items of interest. 

2. Also write up a short paragraph on what was added to the release. This will need to go with the final announce email. Sample:

   Geode 1.13.0 contains a number of improvements and bug fixes.
   It includes performance improvements in OQL order-by and distinct queries in client/server when security is enabled.
   New GFSH commands were added to get/set cluster config and to destroy gateway receivers. A new post processor was 
   added to the new client protocol. Pulse now supports legacy SSL options. Auto-reconnecting members no more reuse 
   old addresses and IDs. Duplicated or member-specific receivers are removed from cluster config during rolling upgrades.
   Users are encouraged to upgrade to the latest release.

Creating a Release Candidate

Accept critical fixes to the support branch

It is expected that some stabilization work may be needed once the support branch is cut.

Proposals to bring completed and tested fixes from develop to the support branch may be made to the dev list.  The release manager may join the conversation if needed to remind the community of the process, for example (omit the time-based part if this is a patch release): 

Hi <thread participant(s)>, thank you for bringing your concern.

Geode's release process dictates a time-based schedule to cut support branches.  Once cut, the “critical fixes” rule allows critical fixes to be brought to the support branch by proposal on the dev list.

If there is consensus from the Geode community that your proposed change satisfies the “critical fixes” rule, I will be happy to bring it to the support/{x.y} branch.

Regards
{Release Manager}

If three +1's are received and no minus 1's, the release manager should:

• confirm that the ticket is already in a resolved state on develop
• confirm the exact commits on develop
• cherry pick to the support branch
  • git cherry-pick -x {SHA} && ./gradlew build 
  • if fix does not cherry-pick and build cleanly, ask that a PR be submitted against the support branch
• send a notification to the thread and mark the issue with the correct fixed-in version in Jira:

There appears to be consensus that this is a critical fix.

The following commit has been brought into support/{x.y} as the critical fix for GEODE-XXXX:

git cherry-pick -x {SHA}

I have marked GEODE-XXXX as also 'resolved in' {x.y.z} in Jira.

Regards
{Release Manager}

No minimum voting period is required to bring a critical fix; it can be merged immediately upon getting 3 +1's.  However, the release manager should monitor and revert it from the support branch if it causes test problems, or further discussion of the fix leads to any "minus 1".

Create the release candidate

1. From one directory above a checkout of latest geode develop, run the prepare_rc script (a release-n.n.n-workspace dir will be created in the current directory).  The support branch should already exist at this point.  This script will do a fresh checkout of the support branch for all repos, build them, and prepare the artifacts. It will also prepare RC tags in each repository and finally pre-stage to nexus.  Do not run this in a remote shell or headless environment, as a GUI is required to prompt for your GPG passphrase (several times) and your ASF LDAP password (Apache password). Do not include @apache.org in your apache username.  If your are not a PMC member, when prompted for SVN password, hit enter and get a PMC member to enter their username and password, otherwise you will not be able to make the final release later.

   geode/dev-tools/release/prepare_rc.sh -v 1.13.0.RC1 -k last_8_digits_of_your_gpg_key -a your_apache_ldap_username

2. The "next steps" printed out at the end of the prepare_rc script will walk you through the remaining steps to finalize nexus staging (pictured below), publish the release candidate, and send the VOTE email.

3. 

If there is an older geode staging repository listed (from a previous RC, make sure you drop it. Find "orgapachegeode-####" and click on "Drop"

Sanity Checks

1. As instructed by commit_rc, before giving the RC to the community to validate, make an rc pipeline to validate that the artifacts are viable:

geode/dev-tools/release/deploy_rc_pipeline.sh -v 1.13.0

2. wait for all jobs to turn green

3. In the next step will send an email...be sure to click EVERY link in the email before sending!

Send out an email announcing the RC

The last instruction from the prepare_rc script will be to run the commit_rc script.  When that is complete, it will print out the contents of the email for you to send (and also copy it to your clipboard, if you have pbcopy installed).  If you need to re-generate the email for any reason, use geode/dev-tools/release/print_rc_email.sh.  Validate (visit) all links, then send the email to the dev@geode.apache.org with subject "[VOTE] Apache Geode <ver>RC<rc>".  

Tally the votes

After the deadline has passed, reply to the VOTE thread with a voting result summary similar to the following (use the PMC roster to determine which votes are binding):

It's past the announced deadline and we have enough votes to close the vote.

Voting status
==========
+1: 3 binding votes
* Name (PMC member)
* Name (PMC member)
* Name (PMC member)
* Other Name
* Other Name

+0: zero votes

-0: zero votes

-1: zero votes

The voting meets the requirements of at least 3 PMC members with +1 votes and has the required majority of +1 votes.
Apache Geode {ver}.RC{n} passed the vote and we will finalize the release shortly.

Thanks everyone for the great work!

-{Release Manager}

If not enough votes are received, the release manager may, at their discretion, extend the voting deadline, or close the vote and start a DISCUSS thread on whether to abandon the release or try again.

If the voting is successful, proceed to the next section.  If showstopper issues were raised, create a new release candidate.  If the release is to be abandoned, destroy any staged artifacts in nexus and svn.

Finalizing the Release

Promote the release candidate to official release

Once a release candidate has been approved:

1. Click 'Release' in http://repository.apache.org/ (pictured below step 5)
2. Fork https://github.com/Homebrew/homebrew-core
3. Make sure you can run docker info and docker images.  If you are on Linux, you may first need to do: sudo groupadd docker && sudo usermod -aG docker $USER

4. From the same directory you ran the previous release scripts, run the promote_rc script (note: you must be a Geode PMC member to commit to dist/release/geode):

   geode/dev-tools/release/promote_rc.sh -v 1.13.0.RC1 -k 'your_40_digit_gpg_key' -g your_github_username

5. The "next steps" printed at the end of the promote_rc script will walk you through the remaining tasks to validate the docker image, update Jira, wait overnight for mirrors to sync, make the brew PR, then finalize the release.
   
   

Mark the version as released in Jira

1. Go to https://issues.apache.org/jira/projects/GEODE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page
2.  Click on the ... to get the Actions pop-up menu
3. While you're in there, add the next release (i.e. if you are releasing x . y . n, add x . y . n+1) 
4. Click Release (note: you must be in the Jira Administrators group to do this, ask on the dev list if you are not).

Transition JIRA issues fixed in this release from Resolved → Closed

1. List all the JIRAs with fix version as the release version and status as resolved.
   
   
   
   
2. Using bulk operations → transition to closed state.
   
   
   
   
   
   
   
   
   
   
   

Publish javadocs and documentation to the website

Ask on the dev list if you need help with these steps.

1. Keep only the latest patch release of each of the 3 most recent minors (including the one you're about to release) on https://geode.apache.org/releases/

2. Build website from sources as described in geode-site/website/README.md.
3. In the generated site, create the directory geode-site/content/releases/latest.
4. Obtain a copy of the javadoc directory from the binary release and put it in the geode-site/content/releases/latest directory (link from the website's Docs landing page points to ../releases/latest/javadoc).
5. Deploy the generated site by checking it into the asf-site branch of the apache-geode repo.

Wait for mirror sites to sync

*** this is a good time to call it a day...mirrors take overnight to sync the new release ***

Don't forget to finish the remaining "Next steps" from promote_rc in the morning.

Final checks

1. Confirm that your brew PR has been merged or closed and brew install apache-geode picks up the new release.  

   brew install apache-geode
   gfsh version

2. Check that docs for the version you are releasing appear on https://geode.apache.org/docs/
3. Check that download detail for the version you are releasing appear on https://geode.apache.org/releases/
4. Check that the release has propagated to Maven Central.  Sometimes this may take a couple days, it seems?  Two ways to do this are: 
   1. Check for the version you are releasing to appear on https://mvnrepository.com/artifact/org.apache.geode/geode-core
   2. Plus the Examples pipeline for your support branch (e.g. at https://concourse.apachegeode-ci.info/teams/main/pipelines/apache-support-1-13-examples)

Ask for a volunteer to update dependencies

Now is the best time to bump dependency versions on the various 3rd-party libraries used by Geode. To do that, we need to Start a DISCUSS thread asking for a volunteer to lead this effort.

To:  dev@geode.apache.org

Subject: [DISCUSS] Someone to update 3rd-party libraries used by GEODE

Hello Apache Geode Community, 

It is time to update the 3rd-party libraries used by GEODE. To get that done, I am requesting a volunteer to take on the responsibility.

This consists of going through the libraries we depend on and updating them to the latest version that works with our code.

It would be nice to get this done within the next week or two, so that we have time to shake out issues before the next release.

Regards,
{Release Manager} on behalf of the Apache Geode team

Send the announce mail

To:  user@geode.apache.org, announce@apache.org, dev@geode.apache.org

Subject: [ANNOUNCE] Apache Geode 1.13.0

*** Important: Send the email from your apache email ID*** (otherwise announce@apache.org will bounce. See https://reference.apache.org/committer/email for how to send email from your apache email address)

The Apache Geode community is pleased to announce the availability of
Apache Geode {version}.

Apache Geode is a data management platform that provides a database-like
consistency model, reliable transaction processing and a shared-nothing
architecture to maintain very low latency performance with high concurrency
processing.

Geode {version} contains a number of improvements and bug fixes. It includes performance improvements in OQL order-by and distinct queries in client/server when security is enabled. New GFSH commands were added to get/set cluster config and to destroy gateway receivers. A new post processor was added to the new client protocol. Pulse now supports legacy SSL options. Auto-reconnecting members no more reuse old addresses and IDs. Duplicated or member-specific receivers are removed from cluster config during rolling upgrades. Users are encouraged to upgrade to the latest release.
For the full list of changes please review the release notes:
https://cwiki.apache.org/confluence/display/GEODE/
Release+Notes#ReleaseNotes-{version}

The release artifacts can be downloaded from the project website:
http://geode.apache.org/releases/

The release documentation is available at:
http://geode.apache.org/docs/guide/{version eg. in the format as 17 or 18 or 19}/about_geode.html

We would like to thank all the contributors that made the release possible.
Regards,
{Release Manager} on behalf of the Apache Geode team