This article contains all the steps required to release Apache Geode.
Table of Contents | ||||
---|---|---|---|---|
|
Before you begin
Software dependencies
- git → https://git-scm.com/downloads
- docker → https://docs.docker.com/docker-for-mac/install/
- gpg tools → https://gpgtools.org
- java JDK8 → https://adoptopenjdk.net Make sure you have the latest patch release of OpenJDK 1.8.0 (not Oracle JDK).
- Homebrew → https://brew.sh/
- svn → [on Mac,
brew install svn
] - 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.
- cmake, doxygen, and openssl - install using an appropriate package manager, e.g. on Mac: brew install doxygen && brew install cmake && brew install openssl
- jinja → pip3 install Jinja2
- PyYAML → pip3 install PyYAML
- text editor (vi or whatever you prefer)
- web browser
Permission and keys
Info | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
To verify
|
Minor vs Patch release
A minor release is a version x.y.0
A patch release is a version x.y.n
where n
> 0
Except where noted, all instructions in this guide apply to both types of releases.
Announce intent to branch (minor only)
Geode nominally cuts support branches for new minor releases on a time-based schedule (Monday on or after Feb 1, May 1, Aug 1, Nov 1), unless otherwise decided on the dev list. A week or two before the scheduled date, send a [DISCUSS] email to dev@geode.apache.org proposing that a new support branch be created. Remind the community that only critical fixes will be allowed once the support branch is created, so it is helpful to have develop as stable as possible before branching.
Note: patch release(s) are initiated by dev list proposal only (not on any time-based schedule), and will include any fixes already accumulated on the support branch(es) plus whatever may be specifically proposed to drive the patch release. Patch release proposals must be made within nine months of the initial minor release.
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.
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'sisApache2
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 (minor only)
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 bumpdevelop
to the next version.Code Block language bash cd .. geode/dev-tools/release/create_support_branches.sh -v 1.13 -g your_github_username
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'
Send email to dev@geode.apache.org informing the creation of the support branch and requesting feedback.
No Format Hello Geode Dev Community, We have created a new support branch for Apache Geode {x.y.0} - "support/{x.y}" Please focus your acceptance testing on this branch and raise any concerns in the next few weeks. After some quiet period we will package a release candidate and begin voting upon it. Regards {Release Manager}
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 (minor only)
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:
- Does every commit since the last release have a corresponding Jira ticket marked as Fixed in this version?
- 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
- 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.
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.
Proposals to bring completed and tested fixes from develop to the support branch may be made to the dev list. The release manager should confirm that the ticket is in a resolved state on develop and has passed automated testing on develop.
Once three +1's are received (and no "minus 1"), the release manager may give the go-ahead for whoever proposed the fix to bring it to the support branch (via a PR or a cherry-pick -x).
After the fix has been merged, make sure the issue is marked with the correct fixed-in version(s) in Jira (every branch the commit is brought to should be listed).
No minimum voting period is required to bring a critical fix; it can be merged immediately upon getting three +1's. However, the release manager should monitor and be prepared to revert it from the support branch if it causes test problems, or further discussion of the fix leads to any "minus 1".
Create the release candidate
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). The support branch should already exist at this point. 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 get 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
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.
If there is an older geode staging repository listed (from a previous RC, make sure you drop it. Find "orgapachegeode-####" and click on "Drop"
Sanity Checks
- As instructed by
commit_rc
, before giving the RC to the community to validate, make anrc
pipeline to validate that the artifacts are viable:
Code Block | ||
---|---|---|
| ||
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
.
Be sure to click on EVERY link to validate, then send the email to the dev@geode.apache.org with subject "[VOTE] Apache Geode <ver>.RC<n>".
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):
Code Block | ||
---|---|---|
| ||
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 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 any staged artifacts in nexus and svn.
Finalizing the Release
Promote the release candidate to official release
Once a release candidate has been approved:
- Click 'Release' in http://repository.apache.org/ (pictured below step 5)
- Fork https://github.com/Homebrew/homebrew-core
- Make sure you can run
docker
info
anddocker
images
. On Linux, be sure to add the your user to the docker group to avoid requiring sudo (sudo usermod -aG docker $USER
). 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 'your_40_digit_gpg_key' -g your_github_username
- 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.
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
- Click on the
...
to get the Actions pop-up menu - While you're in there, add the next release (i.e. if you are releasing x . y . n, add x . y . n+1)
- Click Release (note: you must be in the Jira Administrators group to do this, ask on the dev list if you are not).
Transition JIRA issues fixed in this release from Resolved → Closed
- List all the JIRAs with fix version as the release version and status as resolved.
- Using bulk operations → transition to closed state.
Publish javadocs and documentation to the website
Ask on the dev list if you need help with these steps.
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/
- 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 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).
- Deploy the generated site by checking it into the asf-site branch of the apache-geode repo.
Wait for mirror sites to sync
*** this is a good time to call it a day...mirrors take overnight to sync the new release, and sometimes days for mavencentral ***
Don't forget to finish the remaining "Next steps" from promote_rc
in the morning.
Final checks
(note: These steps are also covered by the "Next steps" from promote_rc
)
Confirm that your brew PR has been merged or closed and
brew install apache-geode
picks up the new release.Code Block brew install apache-geode gfsh version
- Check that docs for the version you are releasing appear on https://geode.apache.org/docs/
- Check that download detail for the version you are releasing appear on https://geode.apache.org/releases/
- Check that the release tag appears as "Verified" in https://github.com/apache/geode/tags (if not, see last step in Permissions and Keys)
- Check that the release has propagated to Maven Central. Sometimes this may take a couple days, it seems? Two ways to check this are:
- Check for the version you are releasing to appear on https://mvnrepository.com/artifact/org.apache.geode/geode-core
- Plus the Examples pipeline for your support branch (e.g. at https://concourse.apachegeode-ci.info/teams/main/pipelines/apache-support-1-13-examples)
Ask for a volunteer to update dependencies
Now is the best time to bump dependency versions on the various 3rd-party libraries used by Geode. To do that, we need to Start a DISCUSS thread asking for a volunteer to lead this effort.
Subject: [DISCUSS] Someone to update 3rd-party libraries used by GEODE
No Format |
---|
Hello Apache Geode Community, It is time to update the 3rd-party libraries used by GEODE. To get that done, I am requesting a volunteer to take on the responsibility. This consists of going through the libraries we depend on and updating them to the latest version that works with our code. It would be nice to get this done within the next week or two, so that we have time to shake out issues before the next release. Regards, {Release Manager} on behalf of the Apache Geode team |
Send the announce mail
To: user@geode.apache.org, announce@apache.org, dev@geode.apache.org
Subject: [ANNOUNCE] Apache Geode 1.13.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 |