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/ svn → shipped with MacOS [install with command line tools → https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools]
3. gpg tools → https://gpgtools.orgweb browser → 
4. java JDK8 → https://adoptopenjdk.net Make sure you have the latest patch release of OpenJDK 1.8.0 (not Oracle JDK).
5. Homebrew → support.google.com/chrome/answer/95346?co=GENIE.Platform%3DDesktop&hl=enjava JDK → https://docsbrew.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html
6. text editor : vi → should be pre-installed
7. Homebrew → https://brew.sh/

Permission and keys:

1. sh/
2. svn → [on Mac, brew install svn]
3. fly → use platform-appropriate download link in bottom right corner of https://concourse.apachegeode-ci.info. Do it this way, not with homebrew, so you get the version that matches concourse.
4. cmake, doxygen, and openssl - install using an appropriate package manager, e.g. on Mac: brew install doxygen && brew install cmake && brew install openssl
5. jinja → pip3 install Jinja2
6. PyYAML → pip3 install PyYAML
7. text editor (vi or whatever you prefer)
8. web browser

Permission and keys

Creating the release branch:

Terminology

A major release is a version x.0.0 and allows/implies breaking changes, removal of deprecated methods, changes to minimum JDK, etc. 

A minor release is a version x.y.0 where y > 0 and typically allows/implies new features.

A patch release is a version x.y.n where n > 0 and should contain a limited number of critical fixes only.

Except where noted, all instructions in this guide apply to all three types of releases.  Dev list proposals for patch releases may be made at any time since the branch already exists, however some planning ahead is helpful for major or minor releases. since it is usually desirable to cut the branch a couple months in advance. 

Propose cutting a support branch (major/minor only)

Send a [DISCUSS] email to dev@geode.apache.org proposing that a new support branch be created.

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. cd .. && ./geode/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.  If a new 3rd-party .jar is now appearing in the binary distribution, update geode-assembly/src/main/dist/LICENSE appropriately.   If new 3rd-party intellectual property was checked into the source tree (e.g. a javascript library), update both LICENSE and geode-assembly/src/main/dist/LICENSE.

Branching for release

Create the support branches (major/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.

   Code Block
   language bash
   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 usually be {previous release} 

   See ci/pipelines/shared/jinja.variables.yml around line 20 (under benchmarks:)

   Code Block
   language yml
   baseline_version: '1.12.0'

   
   

3. Send email to dev@geode.apache.org informing the creation of the support branch and any rules for backporting changes to the branch.

4. Check for the most recent develop SHA that passes all the tests and contains all the features / bug fixes that need to go into the release at https://concourse.apachegeode-ci.info/beta/teams/main/pipelines/develop/jobs/UpdatePassingRef.
5. Ensure in JIRA, that all tickets with {version} as the fix version are either closed or resolved. If not inform the the assignees to either resolve/close it or if not fixed then increment the fix version in the ticket

Create the release branch.

Code Block
title Create release branch
git checkout -b release/{version}

6. gradle.properties

   1. 1. remove -SNAPSHOT in releaseType 
7. docker/Dockerfile
   1. 1. Update GEODE_GPG with your GPG fingerprint.
      2. Update GEODE_VERSION with the release version (eg. 1.8.0)

8. Update the version number in all the expected pom files. Doing it manually takes a lot of time. If you choose to do it I have listed the files below. Otherwise please use the script below to do it.

   Info

   title	Updating the expected-pom files

   - build geode after the version is updated in gradle.properties. NOTE: The build will fail but will have the correct expected-pom.xml files

   Code Block
   language bash title gradle build
   ./gradlew clean build -Dskip.tests=true

   - Update dependency versions using gradle task updateExpectedPom.

   Code Block
   language bash title gradle uEP
   ./gradlew uEP

   - Publish the release branch to origin

   Code Block
   title Publish the release branch
   git add . git commit -a -m "Upgraded version number for releasing {version}" pit push origin release/{version}

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

   No Format
   Hello Geode Dev Community, We have created a new release branch for Apache Geode {version} - "release/{version}" Please do review and raise any concern with the release branch. If concerns are raised, we will start with the voting for the release candidate soon. Regards {Release Manager}

   Setting up concourse release pipeline

   a. You can deploy a release pipeline by deploying a meta pipeline. Run

   No Format
   Hello Geode Dev Community, $ cd ci/pipelines/meta $ ./deploy_meta.sh # You might need fly in your PATH # fly target named `concourse.apachegeode-ci.info` $ fly -t concourse.apachegeode-ci.info login --concourse-url https://concourse.apachegeode-ci.info/

   b. Send a email to dev@geode.apache.org requesting creation of a CI pipeline

   No Format
   Hello Geode Dev Community, AsWe we have created a new releasesupport branch for Apache Geode {versionx.y.0} - "releasesupport/{versionx.y}" please create a CI pipeline for running tests on this branch. Regards {Release Manager}

Release Doc preparation:

...

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

Prepare develop branch for the next release

...

1. 1. update versionNumber to the next release version (for example: if you created release branch for 1.8.0 update version number to 1.9.0 in the below files in develop branch)
   2. ensure that releaseType has -SNAPSHOT in it.

...

Add the new ordinal

//Add 5 to the previous ordinal
private static final byte GEODE_190_ORDINAL = 100;

Add the new version 

public static final Version GEODE_190 =
    new Version("GEODE", "1.9.0", (byte) 1, (byte) 9, (byte) 0, (byte) 0, GEODE_190_ORDINAL);

Set the current version to the new version

public static final Version CURRENT = GEODE_190;

Update the highest version

public static final int HIGHEST_VERSION = 105;

...

Add the next version to addCommands

ALL_COMMANDS.put(Version.GEODE_190, commands);

...

1. Please focus your acceptance testing on this branch and raise any concerns in the next few weeks. If any changes are needed please add blocks-{x.y.0} label in Jira and create a PR against support/{x.y}. After some quiet period we will prepare a release candidate and begin voting upon it. Regards {Release Manager}

   
   

2. 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 (ask for volunteers on the dev list to investigate any failures you are unsure of).

Bump the version of the develop branch (major/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).

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:

   
   

   No Format

   Geode 1.13.0 contains a number of improvements and bug fixes. Changes since last release: - 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 longer 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.  This phase may be very short or very long until a Release Candidate is proposed.

The Release Manager will set the rules for backporting changes to the support branch.  For example, they may stipulate critical fixes only and/or require a dev list proposal and/or require a PR against the support branch and/or require a label to be added in Jira. In all cases, fixes need to be made on develop first, then backported.

By some method, determine when all fixes are in.  This might involve one or more of:

• checking for Jira tickets tagged as blockers that are not yet delivered
• checking for PRs that are not yet merged
• checking on the dev list for proposals
• waiting for any test failures or other concerns to be resolved
• waiting for some quiet period of no new blocker, PRs, proposals, or concerns.

When all signs point to "go", you can either just create the RC and propose it in one email, or if there is any uncertainly, start a dev list discussion first. 

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).  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 ask a PMC member to enter their username and password, otherwise you will not be able to make the final release later.

   Code Block
   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. Image Added

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

Image Added

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 (do this in a separate terminal window as it can be quite verbose):

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

2. wait for all jobs to turn green (about 1-2 hours)

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.  

Click on every link to validate (especially release notes!), then send the email to the dev@geode.apache.org with subject "[VOTE] Apache Geode <ver>.RC<n>".

The voting deadline should be at least 72 hours in the future (typically 3pm 5 days hence if there is a weekend).  For emergency patch releases, an expedited voting deadline of as little as 24 hours may be used.

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} has 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 abandon the release.

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 (shipping) 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 7)
2. Make sure you have forked https://github.com/Homebrew/homebrew-core (click the Fork button in top-right corner)
3. Make sure you have forked https://github.com/apache/geode-native
4. Make sure you have forked

Update the expected-pom.xml files

...

- build geode after the version is updated in gradle.properties. NOTE:The build will fail but will have the correct pom-default.xml files

./gradlew clean build -Dskip.tests=true

- Update dependency versions using gradle task updateExpectedPom.

./gradlew uEP

- Publish the develop branch to origin

git add .
git commit -a -m "Upgraded version number for releasing 1.x.x"
pit push origin develop

Creating the release candidate:

Checkout the release branch.

1. If you are using GPG Tools >= 2.1, export your secret key to a file to be used by Gradle. You can export it with `gpg --export-secret-keys >~/.gnupg/secring.gpg`
            
2. Log in to repository.apache.org and select staging repositories. Find "orgapachegeode-####" and clink on "Drop"
   Image Removed

Clean and build the artifacts. Run this command on a machine using GUI as you will be prompted to enter PGP and ASF LDAP password (Apache password). You will see messages like "Could not find metadata org.apache.geode:geode-cq/maven-metadata.xml" on your terminal. Ignore them.

Code Block
language bash
git clean -fdx && ./gradlew clean build publish -Paskpass -Psigning.keyId=last_8_characters_of_your_gpg_fingerprint -Psigning.secretKeyRingFile=/Users/yourusername/.gnupg/secring.gpg mavenUsername=your_apache_ldap_username

Sign the source release.

Code Block
language bash
cd ${GEODE_SRC}/geode-assembly/build/distributions/* gpg --armor -u {KEY ID} -b apache-geode-{version}-src.tgz

Copy and release artifacts to ASF dist repo. DO NOT DELETE THE FOLDERS CREATED IN THIS STEP - THEY ARE NEEDED FOR THE FINAL RELEASE.

Code Block
language bash
#create a new empty directory svn checkout https://dist.apache.org/repos/dist --depth empty svn update --set-depth infinity --parents dist/dev/geode svn update --set-depth infinity --parents dist/release/geode cd dist/dev/geode # copy the KEYS file from the apache-geode release branch folder in your system. cp ${GEODE_SRC}/KEYS . svn commit -m "Updating Apache Geode KEYS file" mkdir {version}.RC# cp ${GEODE_SRC}/geode-assembly/build/distributions/* {version}.RC# svn add {version}.RC# svn commit -m "Releasing Apache Geode {version}.RC# distribution"

3. Verify that all the artifacts have been uploaded to the nexus repository by logging into repository.apache.org and then click on close. Example:
   Image Removed

4. In the release branch folder tag the commit. All Release Candidates start with the number 1 eg. RC1. Be careful as rel/ folder is protected, once we push the release tag to server, it cannot be modified. Any other change will have to be moved to the next RC number.

   Code Block
   language bash
   git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0" git push origin rel/v{version}.RC#

   Now checkout the repo for geode-examples and create a release branch.

   Code Block
   title Create release branch
   git checkout -b release/{version}

   Update the version number in gradle.properties of geode-examples

   Code Block
   version = 1.7.0 geodeVersion = 1.7.0

   In the geode-examples folder, build and run it with the apache-geode version that was uploaded to the ASF dist repo.

   Code Block
   # first build the release artifacts, specifying the RC release location and staging repository ./gradlew -PsignArchives -PgeodeReleaseUrl=https://dist.apache.org/repos/dist/dev/geode/{version}.RC# -PgeodeRepositoryUrl=https://repository.apache.org/content/repositories/orgapachegeode-{NNNN} build runAll #if all tests pass then continue ahead, else kindly fix the issues

   If there are no failures, then upload the artifacts to ASF dist repo using the folder created in step 6

   Code Block
   # then upload the release artifacts for distribution # go to the folder created in step 6 and copy the geode-example artifacts to it cd dist/dev/geode cp ${GEODE_EXAMPLES_SRC}/build/distributions/* {version}.RC# svn add {version}.RC#/apache-geode-examples-* svn commit -m "Adding examples to Apache Geode {version}.RC# distribution"

   Tag the release candidate in geode-examples.

   Code Block
   # then tag the release candidate commit cd ${GEODE_EXAMPLES_SRC} git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0" git push origin rel/v{version}.RC#

   Info
   If you are running on linux, you may see this error message: error: gpg failed to sign the data error: unable to sign the tag  If you get that error message, try to sign some random file so that gpg will unlock your keyring. After that the git tag -s should work.

   Checkout geode-native from https://github.com/apache/geode-native. Then `cd` into the geode-native directory, create a build directory, configure cmake and generate the source distribution via cpack

   Code Block
   language bash
   mkdir build cd build cmake .. -DPRODUCT_VERSION={version} cpack -G TGZ --config CPackSourceConfig.cmake

5. This should have generated a tar file and a corresponding checksum file. Let's sign the package:

   Code Block
   language bash
   gpg --armor -u {key ID} -b apache-geode-native-{version}-Source.tar.gz

   Verify that the command created a new file called `apache-geode-native-{version}-Source.tar.gz.asc`.

Copy files into release distribution

Code Block
language bash
cd dist/dev/geode cp ${GEODE_NATIVE_SRC}/build/apache-geode-native-{version}* {version}.RC# svn add {version}.RC#/apache-geode-native-* svn commit -m "Adding Geode Native source distribution to Apache Geode {version}.RC#"

Code Block
# then tag the release candidate commit cd ${GEODE_NATIVE_SRC} git tag -s rel/v{version}.RC# -m "Release candidate # for 1.0.0" git push origin rel/v{version}.RC#

Update the version in geode-example develop branch.

Update the version in gradle.properties to the next release's snapshot

version = 1.9.0-SNAPSHOT
geodeVersion = 1.9.0-SNAPTSHOT

Send out an email announcing the RC

...

Hello Geode dev community,


This is the {first/second} release candidate for Apache Geode, version {version}.
Thanks to all the community members for their contributions to this
release!
Please do a review and give your feedback. The deadline is the end of day {deadline date}.  
It resolves {# issues resolved} issues on Apache Geode JIRA system. Release notes can be found at:
https://cwiki.apache.org/confluence/display/GEODE/
Release+Notes#ReleaseNotes-{version}
Please note that we are voting upon the source tags: rel/v{version}.RC{#}
Apache Geode:
https://github.com/apache/geode/tree/rel/v{version}.RC{#}
Apache Geode examples:
https://github.com/apache/geode-examples/tree/rel/v{version}.RC{#}
Commit ID:
Apache Geode:
{----------SHA256 of the last git commit of geode ---------------------}
Apache Geode Examples:
{----------SHA256 of the last git commit of geode examples---------------------}
Apache Geode Native:
{----------SHA256 of the last git commit of geode examples---------------------}
Source and binary files:
https://dist.apache.org/repos/dist/dev/geode/{version}.RC{#}/
Maven staging repo:
https://repository.apache.org/content/repositories/orgapachegeode-{repo#}
Geode's KEYS file containing PGP keys we use to sign the release:
https://github.com/apache/geode/blob/develop/KEYS
Signed the release with fingerprint:
{ PGP public keys of the release manager}
{---------------------------------------}
{-------EXAMPLE-------------------------}
{rsa4096 2018-01-04 [SC] [expires: 2022-01-04]}
{CE6CD0A89480B1B9FCB98699274C66710770C135}

PS: Command to run geode-examples: ./gradlew -PgeodeReleaseUrl=https://dist.apache.org/repos/dist/dev/geode/{version}.RC# -PgeodeRepositoryUrl=https://repository.apache.org/content/repositories/orgapachegeode-{repo id} build runAll
Regards
{release manager}

Finalizing the release

Once the release candidate has been approved 

...

Tag the commit with the final version 

git tag -s rel/v{version} -m "Apache Geode v1.0.0 release"
git push origin rel/v{version}

...

Tag the commit with the final version

git tag -s rel/v{version} -m "Apache Geode v1.0.0 release"
git push origin rel/v{version}

Use svn to move the distributions from dev to release. Use the folders created in step 6 of "Creating the release candidate" section.

# in the directory created created in step 6 of "Creating the release candidate" section.

cd dist
svn mv dev/geode/{version}.RC#/ release/geode/{version}
svn commit -m "Releasing Apache Geode {version} distribution"

Update the keys in dist/release.

# in the directory created created in step 6 of "Creating the release candidate" section.


cp dev/geode/KEYS release/geode/KEYS
svn commit -m "Updating Apache Geode KEYS file"

...

Merge release branch to develop  and master for apache geode and then delete the release branch

git checkout master
git merge -s recursive -Xtheirs release/{version}
git push origin master
  
git checkout develop
git merge -s recursive -Xtheirs release/{version}
git push origin develop
 
git branch -d release/{version}
git push origin --delete release/{version}

Merge release branch to develop  and master for geode-examples and then delete the release branch

git checkout master
git merge -s recursive -Xtheirs release/{version}
git push origin master
  
git checkout develop
git merge -s recursive -Xtheirs release/{version}
git push origin develop
 
git branch -d release/{version}
git push origin --delete release/{version}

Apache Geode JIRA resolved → closed

...

Upload the docker image to docker hub.

1. In docker/Dockerfile update the GEODE_GPG with the GPG key you used to sign the release and GEODE_SHA256 with the SHA from https://dist.apache.org/repos/dist/release/geode/{VERSION}/apache-geode-{VERSION}.tgz.sha256 (Replace VERSION with the version you are trying to release).
2. Follow the instruction present in docker/README.md

Update the brew formula

# update brew
brew update


# Navigate to homebrew core directory
cd /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core/Formula



# Create a release branch
git checkout -b apache-geode-{version}


#Open apache-geode.rb
vim apache-geode.rb


# add the correct version in lines below 
# in url update "https://www.apache.org/dyn/closer.cgi?path=geode/{version}/apache-geode-{version}.tgz"
# in sha256 update with the SHA256 from https://dist.apache.org/repos/dist/release/geode/{version}/apache-geode-{version}.tgz.sha256


# save the file 


#commit the file - put the right version in below command.
git add .
git commit -a -m "apache-geode {version}"


# Fork git@github.com:Homebrew/homebrew-core.git to your repositories.
#add the remote 
git remote add myfork {your forked homebrew core repo}


#push to your remote forked repo
git push myfork apache-geode-{version}


#create a PR against git@github.com:Homebrew/homebrew-core.git - monitor the the tests in the PR page


#test it locally.
git checkout master


git merge apache-geode-{version}
brew install --build-from-source apache-geode


#check for gfsh version - should be the released version
gfsh version


# uninstall apache-geode
brew uninstall apache-geode


#reset master to origin
git reset --hard origin/master

Publish javadocs and documentation to the website

...

2. Make sure you can run dockerinfo and dockerimages.  On Linux, you may need to add sudo before each docker command in the promote_rc script and/or sudo usermod -aG docker $USER

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

   Code Block
   geode/dev-tools/release/promote_rc.sh -v 1.13.0.RC1 -k last_8_digits_of_your_gpg_key -g your_github_username

   
   

4. 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, make the brew PR, then finalize the release, followed by the contents of the announce email (also copied to your clipboard, if you have pbcopy installed).  You can also (re)generate the email later using geode/dev-tools/release/print_announce_email.sh.  It's ok to start on the steps below while you are waiting for promote_rc to finish.
   
   Image Added

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 for the version you are releasing
3. Click Release (note: you must be in the Jira Administrators group to do this, ask on the dev list if you are not).
4. While you're in there, add the next patch release (i.e. if you are releasing x . y . n, add x . y . n+1) 

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.
   Image Added
   
   
   
2. Using bulk operations → transition to closed state.
   
   
   Image Added
   
   Image Added
   
   Image Added
   
   Image Added
   
   

Publish to GitHub

1. Go to https://github.com/apache/geode/tags 

2. Locate (but do not click on) the row with the final release tag (e.g. rel/v1.13.0)

3. Click on the 2nd "..." menu (the one to the right of the Verified bubble), then Create release.

4. "Existing tag" should be selected.
5. Fill in Release Title e.g. Apache Geode 1.13.0.

6. Describe the release:

   1. Copy the summary sentence from the release notes.

   2. Add the SHA256 (e.g. from the directory you ran the release scripts, cat release-1.13.0-workspace/geode/geode-assembly/build/distributions/apache-geode-1.13.0.tgz.sha256).

   3. Add a link to the release notes.  Example: 

      Code Block
      title Sample Release Description
      This release contains some new gfsh commands and support for SNI as well as a number of improvements and bug fixes. sha256 for apache-geode-1.13.0.tgz is 8caf6dcafa5c6bb7c10dc7d512d0569dd16e463e01c18997118e20a5f43e6097 See full release notes at https://cwiki.apache.org/confluence/display/GEODE/Release+Notes#ReleaseNotes-1.13.0

      
      

7. Click where it says "Attach binaries" and upload the Apache Geode .tgz (found in the directory you ran the release scripts under release-1.13.0-workspace/geode/geode-assembly/build/distributions/apache-geode-1.13.0.tgz)
8. Click the green Publish Release button. 

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.

Final checks

(note: These steps are also covered by the "Final steps" printed at the end of promote_rc)

1. Confirm that your brew PR has been merged or closed and brew install apache-geode picks up the new release.  Note: this may take overnight...no need to hold the release announcement just for brew.

   Code Block
   brew uninstall apache-geode 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 tag appears as "Verified" in https://github.com/apache/geode/tags (if not, see last step in Permissions and Keys)

Ask for a volunteer to update dependencies on develop (major/minor only)

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

To:  dev@geode.apache.org

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

Hello Apache Geode Community, 

It's time to update the 3rd-party libraries used by GEODE.  We need a volunteer to take on this responsibility.

https://github.com/apache/geode/blob/develop/dev-tools/dependencies/README.md describes how to carry out this task.

It would be awesome to get this done within the next few weeks, to allow plenty of time to shake out any issues before the next release.

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

Remove old unsupported branches (major/minor only)

Geode's N-2 support policy allows patch releases to be proposed for its 3 most recent minors, e.g. on the day 1.15.0 is released, 1.12 would become no longer supported.  But this is not set in stone, so it's probably wise to start a discussion on the dev list before just running this command!

1. remove 1.<N-3> support branch, pipelines and RC tags:

geode/dev-tools/release/end_of_support.sh -v 1.{N-3}

Note tha end_of_support is a destructive command.  It will prompt you to continue, then will delete the branch and pipeline.  If run by accident, these can be restored by re-flying the pipeline and re-pushing the branch (if you or someone has an up-to-date local copy, otherwise google git reflog for more ways to recover a deleted branch).

Send the announce mail

The template for this email was output at the end of promote_rc, or you can re-generate it using geode/dev-tools/release/print_announce_email.sh.  Consider customizing the generated text if there are more upcoming releases (or even waiting and combining the announcements) or if there are notable fixes worth highlighting after the generic "contains a number of fixes".

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

*** Important: Send the email as plain text***(otherwise announce@apache.org will reject the email.  If using gmail, at the bottom of the compose window, click the three-dot menu then click Plain text mode)

Example:

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

Subject: [ANNOUNCE] Apache Geode {version e.g. 1.13.0}

...

Sending the announce mail.

Important: Send the email from an apache email ID.

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

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 {versionversion e.g. 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.
For the full list of changes please review the release notes:
https://cwiki.apache.org/confluence/display/GEODE/
Release+Notes#ReleaseNotes-{version e.g. 1.13.0}

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

The release documentation is available at:
httphttps://geode.apache.org/docs/guide/{version eg. in the format as 17 or 18 or 19113}/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

Post release:

Add the released version to  geode-old-versions/build.gradle

Eg.

addOldVersion('test160', '1.6.0', true)