This article contains all the steps required to release Apache Geode.
Software dependencies
- git → https://git-scm.com/downloads
- 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]
- gpg tools → https://gpgtools.org
- web browser → https://support.google.com/chrome/answer/95346?co=GENIE.Platform%3DDesktop&hl=en
- java JDK → https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html
- text editor : vi → should be pre-installed
- Homebrew → https://brew.sh/
- fly → use platform-appropriate download link in bottom right corner of https://concourse.apachegeode-ci.info
- cmake and doxygen - install with brew on mac (brew install doxygen && brew install cmake)
Permission and keys:
Permission and Keys:
- Ensure that the release manager has bulk modification permissions on Apache Geode JIRA.
To verify
- Go to : https://issues.apache.org/jira/secure/Dashboard.jspa→ login → Issues → Search for Issues → select Geode in the Project list
- After logging in, on the top right side of the page click on Tools → Bulk Change → Current Page
- Select any ticket and click Next
- The Transition Issue option should not be blocked as N/A. If it is not blocked means that you have bulk operation permission.
- If you don't have permissions, send a mail requesting permission to dev@geode.apache.org.
- Ensure you have permission to modify the wiki for the release docs : Release Notes
- The release manager will need to have a Docker Hub credential that has permission to upload Apache Geode to Docker Hub. To get permissions follow the steps below
- If you don't have a docker hub account create one at https://hub.docker.com/
- After creating the docker hub ID, send an email to dev@geode.apache.org requesting access to upload Apache Geode artifacts to Docker Hub mentioning your docker id.
- Ensure that you have a valid pgp key.
- For MacOS use https://gpgtools.org/
- For Ubuntu https://askubuntu.com/questions/100281/how-do-i-make-a-pgp-key
- Ensure that the public key is published and uploaded to servers.
- Ask a fellow committer to co-sign the keys, this ensures that the keys are available on public servers.
- 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`
- Add your public key block to KEYS file in develop branch if they are not already present in it.
On MacOS : (More information available at https://www.apache.org/dev/release-signing.html#basic-facts)
On MacOS terminal(gpg --list-sigs <your name> && gpg --armor --export <your name>) >> keys.log
- Take the contents of keys.log and append it to KEYS file in the develop branch of Apache Geode. Commit and push to origin.
- Also, add the key fingerprint to https://id.apache.org under OpenPGP Public Key Primary Fingerprint. The fingerprint can be found in the GPG Keychain in MacOS or the second line of the command executed in step a.
- Also upload your public key into keyserver
Sample key block which needs to be appended to the KEYS file in develop:
pub rsa4096 2018-01-04 [SC] [expires: 2022-01-04] CE6CD0A89480B1B9FCB98699274C66710770C135 uid [ultimate] Nabarun Nag <nag@cs.wisc.edu> sig 3 274C66710770C135 2018-01-04 Nabarun Nag <nag@cs.wisc.edu> sig 3 C8D3705F9DBE2177 2018-02-26 Jason Huynh <jasonhuynh@apache.org> sub rsa4096 2018-01-04 [E] [expires: 2022-01-04] sig 274C66710770C135 2018-01-04 Nabarun Nag <nag@cs.wisc.edu> -----BEGIN PGP PUBLIC KEY BLOCK----- mQINBFpOogwBEADlT2Ue6XDFHqbM/LbZXhHMw4rcT4ifuBGyibbUbhLWGimav5tI buGRxOViV2q5FNIEYK6Gyfr1kKTlBxCZxkmbNj5lyqgBM7HfL0sTQ2kGd9IE7rPz KQ65yzUdKd4Aacm9Zlfja6pV6vYbMBdd4gcGFfsobh4yD0dZFXBlkEiqKV89PhxG h9PaBFN6FfDYTaUwir2MveV54N5ynPKcVt9Ler5v6wo/1Mr+bxoZ5dy15UMqxgHT YfRDGmLvCPjI0Aabc86bzgi8FJ8QdW1/oBLH/fjDardQOSgGCI7Smz4F52LGXb7Z . . . Y79TWNoe0dBLf6B8dmX+aqfWhziCz2Ijy8lF8sfQl2DalG+YpBkBBsNs8j/6lpHr Fgh2AddGmNuaP+tMFGCtdeHujkSbx7b1UOkxgLTS7nsRM0l6QN4czTNYcaUFgVU4 Ig== =VFqr -----END PGP PUBLIC KEY BLOCK-----
Discussion on JIRAs
Send a [DISCUSS] email to dev@geode.apache.org informing developers that a new release branch is about to be created.
Request developers to respond back if they are waiting to finish a JIRA issue, or feel that a particular JIRA / fix must be included in the release.
Once the discussion comes to a conclusion and everything that is necessary for the release is present in the develop branch we start with creating the release branch.
Creating the release branch:
- 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.
- 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.
Create release branchgit checkout -b release/{version}
gradle.properties
- remove -SNAPSHOT in releaseType
- docker/Dockerfile
- Update GEODE_GPG with your GPG fingerprint.
- Update GEODE_VERSION with the release version (eg. 1.8.0)
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.
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
gradle build./gradlew clean build -Dskip.tests=true
- Update dependency versions using gradle task updateExpectedPom.
gradle uEP./gradlew uEP
- Publish the release branch to origin
Publish the release branchgit add . git commit -a -m "Upgraded version number for releasing {version}" pit push origin release/{version}
Now checkout the repo for geode-examples and create a release branch.
Create release branchgit checkout develop git checkout -b release/{version}
Update the version number in gradle.properties of geode-examples
version = 1.7.0 geodeVersion = 1.7.0
- Commit the version changes and push the release branch of geode-examples
git add -p git commit git push origin HEAD
- Checkout the repo for geode-native and create a release branch
git checkout develop git checkout -b release/{version} git push origin HEAD
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}
Setting up concourse release pipeline
$ 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/
Release Doc preparation:
- Start preparing the release docs at Release Notes. Use information from all the JIRAs that were closed or resolved.
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
- gradle.properties
- 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)
- ensure that releaseType has -SNAPSHOT in it.
- geode-core/src/main/java/org/apache/geode/internal/Version.java
Add the new ordinal
New ordinal//Add 5 to the previous ordinal private static final byte GEODE_190_ORDINAL = 100;
Add the new version
Adding the new versionpublic 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
Set current to new versionpublic static final Version CURRENT = GEODE_190;
Update the highest version
Set current to new versionpublic static final int HIGHEST_VERSION = 105;
- geode-core/src/main/java/org/apache/geode/internal/cache/tier/sockets/CommandInitializer.java
Add the next version to addCommands
CommandInitializerALL_COMMANDS.put(Version.GEODE_190, commands);
- Update the version in geode-book/config.yml and geode-book/redirects.rb on develop.
Update the expected-pom.xml files
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 pom-default.xml files
gradle build./gradlew clean build -Dskip.tests=true
- Update dependency versions using gradle task updateExpectedPom.
gradle uEP./gradlew uEP
- Publish the develop branch to origin
Publish the release branchgit add . git commit -a -m "Upgraded version number for releasing 1.x.x" pit push origin develop
Update the version in geode-example develop branch.
Update the version in gradle.properties to the next release's snapshot
git checkout develop version = 1.9.0-SNAPSHOT geodeVersion = 1.9.0-SNAPSHOT git add -p git commit git push origin HEAD
Creating the release candidate:
From a checkout of geode, run the prepare_rc.sh script. 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.
cd dev-tools/release ./prepare_rc.sh -v version_with_rc -k your_8_digit_key_id
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.
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.
- Review the artifacts and revisions under build before moving in to publishing. You should see these directories
- geode - This is your geode checkout. It should have a tag for your release, eg rel/v.1.9.0.RC4. Make sure that the revision that was built is correct
- geode-examples - The geode examples checkout. Again, check the revision
- geode-native - The geode native checkout.
dist - This is an svn checkout of apache's staging area. It will have artifacts added, but not committed. Review the added artifacts. You should see something like this:
dist> svn status A dev/geode/1.9.0.RC5 A dev/geode/1.9.0.RC5/apache-geode-1.9.0-src.tgz A dev/geode/1.9.0.RC5/apache-geode-1.9.0-src.tgz.asc A dev/geode/1.9.0.RC5/apache-geode-1.9.0-src.tgz.sha256 A dev/geode/1.9.0.RC5/apache-geode-1.9.0.tgz A dev/geode/1.9.0.RC5/apache-geode-1.9.0.tgz.asc A dev/geode/1.9.0.RC5/apache-geode-1.9.0.tgz.sha256 A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.tar.gz A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.tar.gz.asc A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.tar.gz.sha256 A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.zip A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.zip.asc A dev/geode/1.9.0.RC5/apache-geode-examples-1.9.0.zip.sha256 A dev/geode/1.9.0.RC5/apache-geode-native-1.9.0-src.tar.gz A dev/geode/1.9.0.RC5/apache-geode-native-1.9.0-src.tar.gz.asc A dev/geode/1.9.0.RC5/apache-geode-native-1.9.0-src.tar.gz.sha512
If everything looks good, publish the artifacts to the nexus staging repositories.
cd build/geode ./gradlew publish -Paskpass -Psigning.keyId=last_8_characters_of_your_gpg_fingerprint -Psigning.secretKeyRingFile=${HOME}.gnupg/secring.gpg -PmavenUsername=your_apache_ldap_username
- Verify that all the artifacts have been uploaded to the nexus repository by logging into repository.apache.org and then click on close. Example:
- If there is an older geode staging repository listed (from a previous RC, make sure you drop it. Find "orgapachegeode-####" and clink on "Drop"
Publish release artifacts to ASF dist repo. The prepare_rc.sh script should have already added artifacts in dist/dev/geode/full_version_with_rc.
cd dist/dev/geode svn commit -m "Releasing Apache Geode {version}.RC# distribution"
Push the release tags. These were already created (but not pushed) by the prepare_rc.sh script. 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.
cd build/geode git push rel/v[version_with_rc] cd ../../build/geode-examples git push rel/v[version_with_rc] cd ../../build/geode-native git push rel/v[version_with_rc]
Send out an email announcing the RC
From within a geode checkout, run the dist/dev/print_rc_email.sh script to generate an email to send to the dev@geode.apache.org. The subject should be "[VOTE] Apache Geode 1.9.0 RC4"
./print_rc_email.sh -v 1.9.0.RC4 -m 1054
Finalizing the release
Once the release candidate has been approved
- Checkout the release branch for apache geode
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}
- Checkout the release branch for geode-examples
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 5 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 5 of "Creating the release candidate" section. cp dev/geode/KEYS release/geode/KEYS svn commit -m "Updating Apache Geode KEYS file"
- Review the contents of dist/release. Remove any inactive releases. https://dist.apache.org/repos/dist/release/geode/
- Promote the Nexus staging repo → login to repository.apache.org→ Select Staging repositories → Find "orgapachegeode-####" → Click on the Release Button on the toolbar.
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
- List all the JIRAs with fix version as the release version and status as resolved.
- Using bulk operations → transition to closed state.
Upload the docker image to docker hub.
- 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).
- 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
- Build website from sources as described in geode-site/website/README.md.
- In the generated site, create the directory geode-site/content/releases/latest.
- 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).
- Deploy the generated site by checking it into the asf-site branch of the apache-geode repo.
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}. 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
Post release:
Add the released version to geode-old-versions/build.gradle
Eg.
addOldVersion('test160', '1.6.0', true)