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 → shipped with MacOS [install with command line tools → https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools]
4. gpg tools → https://gpgtools.org
5. web browser → https://support.google.com/chrome/answer/95346?co=GENIE.Platform%3DDesktop&hl=en
6. java JDK → https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html
7. text editor : vi → should be pre-installed
8. Homebrew → https://brew.sh/
9. fly → use platform-appropriate download link in bottom right corner of https://concourse.apachegeode-ci.info
10. cmake, doxygen, and openssl - install with brew on mac (brew install doxygen && brew install cmake && brew install openssl)

Permission and keys

Announce intent to branch

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

Also ask the community to confirm that the Geode LICENSE and NOTICE files accurately reflect what is on develop. 

Branching for release

Create the release branch

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

3. Create the release branch.

   git checkout develop
   git checkout -b release/{version}

4. Update the version number in gradle.properties (and remove -SNAPSHOT)

5. Update the version number in ci/pipelines/geode-build/jinja.template.yml

6. Change SNAPSHOT to "" for SEMVER_PRERELEASE_TOKEN in ci/pipelines/meta/meta.properties

7. Update the version number in all the expected pom files:

   ./gradlew clean
   ./gradlew build -Dskip.tests=true #note: ok if build fails expected pom test
   ./gradlew updateExpectedPom

    

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

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

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

9. Publish the release branch to origin

   git add .
   git commit -a -m "Upgraded version number for releasing {version}"
   git push origin HEAD

10. Now checkout the repo for geode-examples (apache/geode-examples.git) and create a release branch.

    git clone git@github.com:apache/geode-examples.git
    git checkout develop origin/develop
    git checkout -b release/{version}

11. Update the version number in gradle.properties of geode-examples and remove -SNAPSHOT

    version = 1.7.0
    geodeVersion = 1.7.0

12. Commit the version changes and push the release branch of geode-examples

    git add -p
    git commit
    git push origin HEAD

13. Checkout the repo for geode-native (apache/geode-native.git) and create a release branch

    git checkout develop
    git checkout -b release/{version}
    git push origin HEAD

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

    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 no concerns are raised, we will start with the voting for the release candidate soon.
    
    Regards
    {Release Manager}

15. Create the concourse release pipeline.

    fly -t concourse.apachegeode-ci.info login --concourse-url https://concourse.apachegeode-ci.info/
    cd ci/pipelines/meta
    ./deploy_meta.sh

16. Monitor the new release pipeline and resolve any issues that may arise. 

Begin preparing release documentation

1. Start preparing the release docs at Release Notes. Use information from all the JIRAs that were closed or resolved. 

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

Bump the version of the develop branch

You will need to checkout the develop branch of geode and geode-examples.

1. update gradle.properties
   1. 1. update the version property to the next release version and ensure that it has -SNAPSHOT on the end. (for example: if you created release branch for 1.8.0 update version number to 1.9.0-RELEASE on the develop branch)
2. if not a patch release, update geode-core/src/main/java/org/apache/geode/internal/Version.java

   1. 1. Add the new ordinal for the new version

         New ordinal

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

      2. Add the new version 

         Adding the new version

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

      3. Set the current version to the new version

         Set current to new version

         public static final Version CURRENT = GEODE_1_9_0;

         
         
         

      4. Update the highest version

         Set current to new version

         public static final int HIGHEST_VERSION = 105;

3. if not a patch release, update geode-core/src/main/java/org/apache/geode/internal/cache/tier/sockets/CommandInitializer.java

   1. 1. Add the next version to addCommands

         CommandInitializer

         allCommands.put(Version.GEODE_1_9_0, geode18Commands);

         
         

4. Update the version in geode-book/config.yml and geode-book/redirects.rb on develop.  Note: do NOT include the patch digit in product_version_nodot in config.yml, even for patch releases

5. Update the expected-pom.xml files

   gradle build

   ./gradlew clean
   ./gradlew build -Dskip.tests=true #note: ok if build fails expected pom test
   ./gradlew updateExpectedPom

6. Review the benchmark baseline.  In theory this could be updated to the new release branch, but the highwater tag is preferable.

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

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

7. Publish the develop branch to origin

   Publish the changes to develop

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

8. Plus the BumpMinor task to increment the concourse version in the apache-geode concourse pipeline at: 
   https://concourse.apachegeode-ci.info/teams/main/pipelines/apache-develop-main?groups=Semver%20Management
   (if you do not have concourse permissions to plus jobs, ask on the dev list)

9. Update the version and geodeVersion in gradle.properties file of the geode-example develop branch to the next release version

   git checkout develop
   version = 1.9.0-SNAPSHOT
   geodeVersion = 1.9.0-SNAPSHOT
   git add -p
   git commit
   git push origin HEAD

10. In Jira, add new version of develop: go to https://issues.apache.org/jira/projects/GEODE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page and fill in the new version and click Add.

Creating a Release Candidate

Accept critical fixes to the release branch

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

Proposals to bring completed and tested fixes from develop to the release 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: 

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

Geode's release process dictates a time-based schedule to cut release branches.  Once cut, the “critical fixes” rule allows critical fixes to be brought to the release 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 {version} release branch.

Regards
{Release Manager}

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

• confirm that the ticket is already in a resolved state on develop
• confirm the exact commits on develop
• cherry pick to the release 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 release 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 release/{version} as the critical fix for GEODE-XXXX:

git cherry-pick -x {SHA}

GEODE-XXXX has been marked as 'resolved in' {version}.

Regards
{Release Manager}

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

Create the release candidate

1. If doing RC2 or later, revert the last temporary commit from geode-examples/gradle.properties and push

   cd geode-examples
   git pull
   git log -1 gradle.properties
   git revert <SHA from above>
   git push

2. From a checkout of latest geode develop, run the prepare_rc.sh script (a build dir will be created in the current directory, so you may not want to be inside geode when you run it or IntelliJ will freak out).  This script assumes there is a release/X.Y.Z branch pushed to all of the geode repositories (geode, geode-native, geode-examples). It will checkout the tip of that branch for all repos, build them, and copy the artifacts to the build/dist directory. It will also tag the RC in each checkout.  Run this command on a machine with a GUI as you will be prompted to enter PGP passphrase several times and finally your ASF LDAP password (Apache password). Do not include @apache.org in your apache username.

   geode/dev-tools/release/prepare_rc.sh -v version_with_rc -k your_8_digit_key_id -a your_apache_ldap_username

3. The "next steps" printed out at the end of the prepare_rc script will walk you through the remaining steps to stage to nexus (pictured below), publish the release, and send an announcement email.

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

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 dev-tools/release/print_rc_email.sh.  Send the email to the dev@geode.apache.org with subject "[VOTE] Apache Geode <ver>RC<rc>".  Reviewers should be encouraged to describe what they tested, not just give a +1.

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 the pipeline, release branch, and staged artifacts in nexus and svn.

Finalizing the Release

Promote the RC tag and RC staging repo

Once a release candidate has been approved 

1. cd to the release branch for apache geode and tag the commit with the final version 

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

2. cd to the release branch for geode-examples and tag the commit with the final version, using same commands as above

3.  cd to the release branch for geode-native and tag the commit with the final version, using same commands as above

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

   # in the directory created in step 1 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"

5. Update the keys in dist/release.

   # in the directory created in step 1 of "Creating the release candidate" section.
   
   
   cp dev/geode/KEYS release/geode/KEYS
   svn commit -m "Updating Apache Geode KEYS file"

6. Promote the Nexus staging repo → login to repository.apache.org→ Select Staging repositories → Find "orgapachegeode-####" → Click on the Release Button on the toolbar.
   
   

7. Revert the temporary commit from geode-examples/gradle.properties and push

   cd geode-examples
   git pull
   git log -1 gradle.properties
   git revert <SHA from above>
   git push

Transition JIRA issues fixed in this release from Resolved → Closed

1. Mark the version as released in Jira: go to https://issues.apache.org/jira/projects/GEODE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page and click on the ... to get the Actions pop-up menu and click Release.

2. List all the JIRAs with fix version as the release version and status as resolved.
   
   
   
   

Using bulk operations → transition to closed state.










Wait for mirror sites to sync

*** this is a good time to go home / take a nap / finish it tomorrow.  mirror sites can take 8-24 hours to sync, and the below docker and brew and announce steps depend on most or all mirrors being up-to-date.***

Upload the docker image to dockerhub

1. docker/Dockerfile
   1. 1. Update GEODE_GPG with your GPG fingerprint.
      2. Update GEODE_VERSION with the release version (eg. 1.8.0)
      3. Update 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. Check these changes in to the release branch. If for some reason you have already merged the release branch to master and deleted it, check the changes in to master.
3. Follow the instruction present in docker/README.md
4. Note that you may see a 404 error during the docker build process, because it tries a mirror first before falling back to the primary download site, and some mirror sites take 8-24 hours to sync.  As long as the docker build completes successfully you're ok.

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

The brew team usually accepts the PR within 24 hours.  Note: they may close it without merging.  Either way, check that latest version has been added to brew by doing brew install apache-geode.

Publish javadocs and documentation to the website

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

Destroy concourse release pipelines

fly -t concourse.apachegeode-ci.info login --concourse-url https://concourse.apachegeode-ci.info/
cd ci/pipelines/meta
./destroy_pipelines.sh

Merge to master and destroy release branches

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

   git fetch --all
   git checkout release/1.9.0
   git merge -s ours origin/master -m "Merging release/1.9.0 into master"
   git checkout master
   git merge release/1.9.0
   git push origin master
     
   git branch -D release/{version}
   git push origin --delete release/{version}

2. Merge release branch to master for geode-examples and then delete the release branch, using same commands as above

3. Merge release branch to master for geode-native and then delete the release branch, using same commands as above

Add released version as "old" on develop

Check out develop and add the released version and update the benchmark baseline.

Eg. in settings.gradle somewhere around line 75:

'1.9.0'].each

and in ci/pipelines/shared/jinja.variables.yml around line 59:

set baseline_branch: ""
set baseline_version: "1.9.0"

It's a good idea to make a PR for this rather than committing directly, since these changes affect tests!

Send the announce mail

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

Subject: [ANNOUNCE] Apache Geode 1.9.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

Remove previous release from mirrors