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
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. 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.
Code Block title Create release branch git 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.
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 no concerns are raised, we will start with the voting for the release candidate soon. Regards {Release Manager}
Setting up concourse release pipeline
No Format $ 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:
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
- 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
Code Block language java title New ordinal //Add 5 to the previous ordinal private static final byte GEODE_190_ORDINAL = 100;
Add the new version
Code Block language java title Adding 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
Code Block language java title Set current to new version public static final Version CURRENT = GEODE_190;
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 ALL_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
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 pom-default.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 develop branch to origin
Code Block title Publish the release branch git add . git commit -a -m "Upgraded version number for releasing 1.x.x" pit push origin develop
Creating the release candidate:
- 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`
From a checkout of geode, run the prepare_rc.sh script
Code Block 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.
- Review the artifacts and revisions under build before moving in to publishing. You should see these directories
- geode
- geode-examples
- geode-native
- dist
- Log in to repository.apache.org and select staging repositories. Find "orgapachegeode-####" and clink on "Drop"
Publish the artifacts to the nexus staging repositories. 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 cd build/geode ./gradlew publish -Paskpass -Psigning.keyId=last_8_characters_of_your_gpg_fingerprint -Psigning.secretKeyRingFile=/Users/yourusername/.gnupg/secring.gpg -PmavenUsername=your_apache_ldap_username
Publish release artifacts to ASF dist repo.
Code Block language bash cd dist/dev/geode svn commit -m "Releasing Apache Geode {version}.RC# distribution"
- Verify that all the artifacts have been uploaded to the nexus repository by logging into repository.apache.org and then click on close. Example:
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 cd build/geodegit push rel/v[version_with_rc]cd ../../build/geode-examplesgit push rel/v[version_with_rc]cd ../../build/geode-nativegit push rel/v[version_with_rc]
Now checkout the repo for geode-examples and create a release branch.
Code Block title Create release branch git checkout develop 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
- Commit the version changes and push the release branch of geode-examples
Code Block git add -p git commit git push origin HEAD
check that gfsh is not on your path already
Code Block $ gfsh -bash: gfsh: command not found
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 git clean -dxf && ./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 tag the release candidate in geode-examples.
Code Block # then tag the release candidate commit cd ${GEODE_EXAMPLES_SRC} git config user.email "email_address_associated_with_your_gpg_key" 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.
Publish the examples artifacts to ASF dist repo using the folder created in step 5
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"
Make sure you have the native client required components installed. On a Mac
Code Block brew install cmake brew install doxygen
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} -DOPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2* -DGEODE_HOME=your_geode_checkout/geode-assembly/build/install/apache-geode cpack -G TGZ --config CPackSourceConfig.cmake
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-*-src.tar.gz
Verify that the command created a new file called `apache-geode-native-{version}-Source.tar.gz.asc`.
Tag the release candidate in geode native:
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#
Publish the geode native artifacts to ASF dist repo using the folder created in step 5
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#"
Update the version in geode-example develop branch.
Update the version in gradle.properties to the next release's snapshot
Code Block | ||
---|---|---|
| ||
version = 1.9.0-SNAPSHOT geodeVersion = 1.9.0-SNAPTSHOT |
Send out an email announcing the RC
From JIRA find out how many JIRAs were resolved and update the links in the below template and send it to dev@geode.apache.org. Everything within {} must be updated in the below template
No Format |
---|
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
- Checkout the release branch for apache geode
Tag the commit with the final version
Code Block 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
Code Block 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.
Code Block # 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.
Code Block # 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
Code Block 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
Code Block 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
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 |
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.
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 |
Post release:
Add the released version to geode-old-versions/build.gradle
Eg.
Code Block |
---|
addOldVersion('test160', '1.6.0', true) |