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, doxygen, and openssl - install with brew on mac (brew install doxygen && brew install cmake && brew install openssl)
Permission and keys:
Info | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
To verify
|
Info | ||
---|---|---|
| ||
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. Request they also confirm that the Geode LICENSE and NOTICE files been confirmed to accurately reflect what is on develop. Once this 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.
Code Block language bash git checkout -b release/{version}
Update the version number in
gradle.properties
(and remove-SNAPSHOT
)Update the version number in
ci/pipelines/geode-build/jinja.template.yml
Change
SNAPSHOT
to""
forSEMVER_PRERELEASE_TOKEN
inci/pipelines/meta/meta.properties
Update the version number in all the expected pom files use these steps:
Code Block language bash ./gradlew clean ./gradlew build -Dskip.tests=true #note: ok if build fails expected pom test ./gradlew updateExpectedPom
Review the benchmark baseline. It should be the more recent of {previous release} or
develop/highwater
.branch
should stay asdevelop
even for release branches. Note: as the release progresses, consider creating and using a dedicatedversion/highwater
tag on the release branch.See ci/pipelines/shared/jinja.variables.yml around line 19:
Code Block language yml benchmarks: baseline_branch: develop/highwater baseline_version: '' branch: develop
Publish the release branch to origin
Code Block language bash git add . git commit -a -m "Upgraded version number for releasing {version}" pit push origin release/{version}
Now checkout the repo for geode-examples (apache/geode-examples.git) and create a release branch.
Code Block language bash git clone git@github.com:apache/geode-examples.git git checkout develop origin/develop git checkout -b release/{version}
Update the version number in gradle.properties of geode-examples and remove -SNAPSHOT
No Format version = 1.7.0 geodeVersion = 1.7.0
- Commit the version changes and push the release branch of geode-examples
Code Block language bash git add -p git commit git push origin
- Checkout the repo for geode-native (apache/geode-native.git) and create a release branch
Code Block language bash 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.
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 no concerns are raised, we will start with the voting for the release candidate soon. Regards {Release Manager}
Create the concourse release pipeline.
Code Block language bash fly -t concourse.apachegeode-ci.info login --concourse-url https://concourse.apachegeode-ci.info/ cd ci/pipelines/meta ./deploy_meta.sh
- Monitor the new release pipeline and resolve any issues that may arise.
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:
No Format 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
You will need checkouts of geode, geode-example and geode-benchmarks
- gradle.properties
- 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)
- geode-core/src/main/java/org/apache/geode/internal/Version.java
Add the new ordinal for the new version
Code Block language java title New ordinal //Add 2 to the previous ordinal private static final byte GEODE_1_9_0_ORDINAL = 100;
Add the new version
Code Block language java title 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);
Set the current version to the new version
Code Block language java title Set current to new version public static final Version CURRENT = GEODE_1_9_0;
Update the highest version
Code Block language java title Set current to new version public 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
Code Block language java title CommandInitializer allCommands.put(Version.GEODE_1_9_0, geode18Commands);
- Update the version in geode-book/config.yml and geode-book/redirects.rb on develop.
Update the expected-pom.xml files
Code Block language bash title gradle build ./gradlew clean ./gradlew build -Dskip.tests=true #note: ok if build fails expected pom test ./gradlew updateExpectedPom
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:
Code Block benchmarks: baseline_branch: develop/highwater baseline_version: '' branch: develop
Publish the develop branch to origin
Code Block title Publish the changes to develop git add . git commit -a -m "Upgraded version number for releasing 1.x.x" pit push origin develop
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%20ManagementUpdate the version and geodeVersion in gradle.properties file of the geode-example develop branch to the next release version
Code Block language bash git checkout develop version = 1.9.0-SNAPSHOT geodeVersion = 1.9.0-SNAPSHOT git add -p git commit git push origin HEAD
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.
Accepting changes into the release branch:
Proposals to bring changes 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:
No Format |
---|
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 the exact commits on develop and cherry pick to the release branch using git cherry-pick -x <SHA>
then send a notification to the thread:
No Format |
---|
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"
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 key 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 remotes/origin/release/1.9.0 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.
Info You may see this error message:
error: gpg failed to sign the data
error: unable to sign the tag
If you do, try to sign some random file so that gpg will unlock your keyring. After that the
git tag -s
used in prepare_rc.sh 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:
Code Block 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.0settings.gradle add new version to geode-old-versions.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. You will be prompted to enter your ASF LDAP password (Apache password)
Code Block language bash 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.
Code Block language bash 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.
Code Block language bash 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"
Code Block |
---|
./print_rc_email.sh -v 1.9.0.RC4 -m 1054 |
Finalizing the release
Once the release candidate has been approved
cd to the release branch for apache geode and tag the commit with the final version
Code Block 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}
cd to the release branch for geode-examples and tag the commit with the final version, using same commands as above
cd to the release branch for geode-native and tag the commit with the final version, using same commands as above
Use svn to move the distributions from dev to release. Use the folders created in step 1 of "Creating the release candidate" section.
Code Block # 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"
Update the keys in dist/release.
Code Block # 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"
- Promote the Nexus staging repo → login to repository.apache.org→ Select Staging repositories → Find "orgapachegeode-####" → Click on the Release Button on the toolbar.
Apache Geode JIRA resolved → closed
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.
- List all the JIRAs with fix version as the release version and status as resolved.
Using bulk operations → transition to closed state.
*** 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 docker hub.
- docker/Dockerfile
- Update GEODE_GPG with your GPG fingerprint.
- Update GEODE_VERSION with the release version (eg. 1.8.0)
- 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).
- 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.
- Follow the instruction present in docker/README.md
- 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
Code Block | ||||
---|---|---|---|---|
| ||||
# 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
- 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.
Destroy concourse release pipelines
No Format |
---|
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 branch
Merge release branch to master for apache geode and then delete the release branch
Code Block 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}
Merge release branch to master for geode-examples and then delete the release branch, using same commands as above
- 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:
Code Block |
---|
'1.9.0'].each |
and in ci/pipelines/shared/jinja.variables.yml around line 59:
Code Block |
---|
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!
Sending 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)
No Format |
---|
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.
remove from apache mirrors
Code Block cd dist/release/geode svn rm {$old_release} svn commit -m "remove old releases (they can still be found at http://archive.apache.org/dist/geode)"
- update https://geode.apache.org/releases/
- change the links (for old versions only, not the one you just released!) that contain closer.cgi to archive, like this:
- before: http://apache.org/dyn/closer.cgi/geode...
- after: http://archive.apache.org/dist/geode...
- change the links for the gpg/md5 links like this:
- before: https://www.apache.org/dist/geode...
- after: https://archive.apache.org/dist/geode...
- change the links (for old versions only, not the one you just released!) that contain closer.cgi to archive, like this: