- Whenever possible, use the maven release plugin. If something doesn't work file a bug against it.
- Use extreme caution in creating branches as opposed to releasing from trunk. While "core" geronimo may need to keep branches, most smaller projects such as specs, plugins, components, and most likely tools should avoid the complexity of branches unless clearly necessary and agreed upon.
- When branches are needed, branches/x.y would be the branch for all x.y.z releases
The next sections are copied from http://maven.apache.org/developers/release/releasing.html with modifications for Geronimo.
Releasing a Geronimo Project
What follows is a description of releasing a Geronimo project to a staging repository, whereupon it is scrutinized by the community, approved, and transfered to a production repository.
Be sure that:
- you have all Maven servers defined in your
settings.xml. For more information, please refer to Maven Committer settings which also apply for Geronimo committers.
- you have created your GPG keys. For more information, please refer to Making GPG Keys.
In order to release a project you must also have the following setup in your
$HOME/.m2/settings.xml which is a profile that defines the staging repository.
Here's what your release profile might look like in your
The server name apache.releases at the start of deploy.altRepository must correspond to the apache.releases server definition.
Also that your apache id does not start with "~".
Everything that you need to release has (will have, actually) been configured in the genesis root pom all Geronimo projects inherit from.
Your project should adhere to standard trunk,branches,tags svn layout in which case no further release profile configuration should be needed. Some slight deviation such as our specs project still works without extra configuration. Avoid more complex layouts that require special configuration.
This is the base release configuration in the genesis root pom:
Release Process as used for Geronimo 2.1.x:
This incorporates some aspects of the maven release process but stops short of actually using the maven release plugin. It utilizes a branch for the release process.
- when a release is frozen, we spin off a branch with that exact name, as in branches/x.y.z, where z starts at zero and increments by one.
- at that time branches/x.y is immediately updated to version x.y.(z+1)-SNAPSHOT
- We cut releases from the frozen branch
- When a release passes final tck testing and final vote, the frozen branch is moved to tags
Updating the poms after making a new branch
Once a new branch is created you will generally need to manage the version number in the poms for parent entries. The following Perl scripts will assist in that task. It could use some polishing but given the relatively infrequent use.
Remember to properly escape periods in the oldVersion. For instance, to change 1.1.1-SNAPSHOT to 1.1.1 you would have
making the above script work
You must replace GeronimoDirectory above with the fully qualified path to the directory (using "~" will not work).
Also Note: there are references to versions outside of the pom parent entries updated by the script which will also need to be updated with the new version.
In addition to the pom version changes there are several other places where version updates are necessary. To be certain all have been updated you should grep the source for old version references to ensure that those remaining are correct. Here is an attempt to capture other version changes necessary:
- scm entried in root pom.xml
In addition, there are some special version updates required in some pom.xml files beyond those addressed by the script:
- assemblies/geronimo-boilerplate-minimal/pom.xml (RELEASE-NOTES filename)
- configs/plugin/pom.xml (plugin-repository-list)
- root pom ... pom.xml
Update the on-going maintenance branch
Make similar changes in the branch that will continue on for the next release.
- Update poms to the next snapshot version
- Update the same files referenced above
- rename RELEASE_NOTES-x.y.z.txt as appropriate
- Some of the "special" updates required are really just applicable here (when creating a new version rather than just removing the snapshot from an existing version). This is especially true for reference to the geronimo plugin repository (which normally named without the snapshot even when the release is still a snapshot release).
In addition, there are special updates for references to release notes and the plugin website:
In addition, there are special updates for artifact-alias entries:
We create a branch at freeze time for the following reasons:
- it takes at least one week from freeze to ship due to voting, tck testing and potential repeats of that process (re-cut, re-certify, re-vote). There is no reason why work on x.y.z+1 needs to be delayed - only 52 weeks a year.
- stronger guarantee no one is updating the branch once frozen
- less likely that people and ci systems (continuum) will checkout and build pre-release versions of x.y.z (not x.y.z-SNAPSHOT) which would need to be removed manually and may accidentally be distributed.
- it is currently very difficult to roll version numbers forward, entries here and there are often missed. Far better to have branches/x.y have a few straggling old x.y.z-SNAPSHOT versions than a few overlooked x.y.z final numbers that needed to go back to SNAPSHOT - they never leave SNAPSHOT and need to be reverted back later if that process happens in the frozen branch.
Creating a Release Candidate
- Download and install the Gnu Privacy Guard (GPG) from http://www.gnupg.org. Read the documentation on that site and create a key. Have the key signed and verified by others. Submit your public key to http://pgp.mit.edu/. This is a one time process.
- Be sure that you have your
~/.m2/settings.xmlupdated as specified above in Releasing a Geronimo Project
- Copy (or move as per situation, for eg specs) the trunk/branch to the new branch using the following command.
- Checkout or update this branches tree on your machine.
- Update the <scm> urls in the
pom.xmlto point to the final url in tags. Eg:
- Add the following release profile to the root pom.xml (Note: This is a subset of the profile included in the maven release process). This will utilize the maven gpg plugin to sign the artifacts produced and the maven deploy plugin to stage the release to your people.apache staging location but will not utilize the maven release plugin to create the tag, rename versions, etc...
- Build the new branches tree as you normally would (including the testsuite) to ensure that it is correct.
- After verifying the updated branch can be built and all tests pass, use the rat-maven-plugin to verify that the source contains required license headers.
There are a few source files that cannot contain license headers due to the expected format of the file (like LogFactory classes.) Compare these files against the last release to verify it's okay to release them without headers and ask the prior release manager and/or dev list for guidance.
- Stage the maven artifacts
When you are ready to create a release candidate, clean out the previous build results from the branches tree (otherwise assemblies will not be rebuilt correctly) and rebuild (without tests or testsuite) to now deploy the artifacts to the staging site that will be used for the release vote using the following command.
Be extremely careful with this step. There have been times when a slight modification in the above command will result in items being deployed directly to the rsync location rather than to the staging location.
Before running this step, verify that there is a corresponding "staging" or "release" profile in pom.xml.
If there are issues/problems with the deploy to the staging location you may have to stage to a local repository and then scp the content to an apache staging location.
- Export and tar/zip the source to be voted on for the release using the following commands: Also create a zip of the source image.
- Create appropriate md5, sha1, and signatures (asc) for the artifacts added manually. A script similar to this can be used to create the checksums and signature:
Ensure that your public PGP key is in appropriate public locations (esp. /www/www.apache.org/dist/geronimo/KEYS on people and http://pgp.mit.edu/) and that your pgp key has been signed by several other apache committers to create a web of trust.
You will need to copy the RELEASE_NOTES-x.x.x.txt from the target location of one of the built assemblies rather than the root of the branch as the version attributes are updated as part of the build.
- Update the plugins site - http://cwiki.apache.org/GMOxDEV/steps-to-create-a-plugin-repository-for-a-new-geronimo-release.html
- Update your local ~/.m2/repository/geronimo-plugins.xml file from a clean server build to:
- Remove all occurrences of your local repo
- Verify that each entry points to the 2 external repos
- Verify that each entry lists JVM 1.5 and 1.6 targets if the release is prior to 3.0. For all 3.x releases, only 1.6 should be specified.
- Update the default repository values by replacing the local repo reference with
- Upload the updated geronimo-plugins.xml to the plugin website in svn http://geronimo.apache.org/plugins/geronimo-2.1.3. This will get automatically published on
- Create the plugin-repository-list-2.1.4.txt for the on-going maintenance branch with
- Create the geronimo-2.1.4 directory for the on-going maintenance branch and seed it with a copy of the .htaccess from the prior release and the following geronimo-plugins.xml content (until a 2.1.4-SNAPSHOT build has been published and new geronimo-plugins.xml file created)
- Commit the changes to svn
- Update your local ~/.m2/repository/geronimo-plugins.xml file from a clean server build to:
- Create a distribution directory on people.apache.org (like ~/public_html/releases/geronimo-2.1.3-RC1) and upload the following artifacts for the vote:
- Source tar & zip
- All assembly images that are part of the vote. This is more for convenience of the voters and to serve as a distribution location once the vote is complete.
- Release notes, README, LICENSE, NOTICE, and DISCLAIMER
- MD5, SHA1 and ASC files for all of the above
Calling a Vote
- Put it up for a vote along with the staging release you created earlier. In the vote notice, please include the precise names and versions being voted on (e.g. geronimo-jetty6-javaee5-2.1.3), the svn revision and urls to the current source along with where the tag will be created.
- Start a vote thread for the release
- Start a discussion thread for the vote
- Send out the vote results in a reply email
- If the vote passed, send a reply to the original [VOTE] email with -
- If the vote was canceled and another release candidate is being created for another vote
Publishing a Release Candidate
- Copy from the staging repo to the production repo.
Once the release is deemed fit for public consumption it can be transfered to a production repository where it will be available to all users. Note: Current version of the stage plugin is 1.0-alpha-1.
Here is an example on how to use the stage plugin:
The version parameter is currently ignored but specify the correct version anyway. The entire staging repository is synced, not just the given version or the current project.
Also note, this process has been known to have problems at times if a maven version other than 2.0.8 is used.
- Copy the distribution content from the staging location to the production repo.
Check in the distribution content into the appropriate location in https://dist.apache.org/repos/dist/release/geronimo/.
- Move the branches to tags using the following command.
- Update the Geronimo site download pages with a new page for the release Geronimo Downloads . Include the list JIRA for know issues by first generating a JIRA query for the release, right clicking on the XML format and saving the url to inclusion in the download page.
- Administer the GERONIMO JIRA project to update the released and unreleased versions
- Update the Geronimo Home Page with a News item that a new Geronimo Server release is available
- Update the Geronimo Release Roadmaps with the release date.
- Final step, is to force the Confluence Autoexport plugin to run for the following spaces: Apache Geronimo (GMOxSITE), Apache Geronimo Project Management (GMOxPMGT), Apache Geronimo 2.1 (GMOxDOC21)
The original process in this document was voted on by the Geronimo community. Please formally propose all changes to email@example.com.
Revised process using maven tools voted on in March 2008. Only major structural changes now require votes.
See: (not yet in archive)