Procedure
- 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.
Prerequisite
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 $HOME/.m2/settings.xml :
<settings>
<profiles>
<profile>
<id>release</id>
<properties>
<gpg.passphrase>secretPhrase</gpg.passphrase>
<deploy.altRepository>apache.releases::default::scp://people.apache.org/x1/home/[your apache id]/public_html/staging-repo/${siteId}</deploy.altRepository>
<staging.siteURL>scp://people.apache.org/x1/home/[your apache id]/public_html/staging-site</staging.siteURL>
</properties>
</profile>
<profile>
<!-- use for local site deploy testing and local deploy testing -->
<id>local</id>
<properties>
<deploy.altRepository>djencks::default::file://[home directory]/staging-repo/${siteId}</deploy.altRepository>
<gpg.passphrase>secretPhrase</gpg.passphrase>
<staging.siteURL>file://[home directory]/staging-site</staging.siteURL>
</properties>
</profile>
</profiles>
<servers>
<server>
<id>apache.releases</id>
<username>[your apache id]</username>
<passphrase>[secret passphrase]</passphrase>
<filePermissions>664</filePermissions>
<directoryPermissions>775</directoryPermissions>
</server>
<server>
<id>geronimo-website</id>
<username>[your apache id]</username>
<passphrase>[secret passphrase]</passphrase>
<filePermissions>664</filePermissions>
<directoryPermissions>775</directoryPermissions>
</server>
</servers>
</settings>
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:
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<configuration>
<useReleaseProfile>false</useReleaseProfile>
<goals>deploy</goals>
<arguments>-Prelease</arguments>
</configuration>
</plugin>
<!-- We want a source jar -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- We want to sign the artifact, the POM, and all attached artifacts -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<inherited>true</inherited>
<configuration>
<passphrase>${gpg.passphrase}</passphrase>
</configuration>
<executions>
<execution>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<!-- We want to deploy the artifact to a staging location for perusal -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<inherited>true</inherited>
<configuration>
<altDeploymentRepository>${deploy.altRepository}</altDeploymentRepository>
<updateReleaseInfo>true</updateReleaseInfo>
</configuration>
</plugin>
<!-- We want the JavaDoc JAR published with the release -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<inherited>true</inherited>
<configuration>
<source>1.5</source>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
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.
perl -i.orig -pe '
$done = 0 if /<?xml/;
$inParent = 1 if not $done and /<parent>/;
s,oldVersion</version>,newVersion</version>, if $inParent and not $done;
$done = $inParent = 1 if /<\/parent>/;
' $(find GeronimoDirectory -name pom.xml | grep -v "GeronimoDirectory/pom.xml")
Remember to properly escape periods in the oldVersion. For instance, to change 1.1.1-SNAPSHOT to 1.1.1 you would have
perl -i.orig -pe '
$done = 0 if /<?xml/;
$inParent = 1 if not $done and /<parent>/;
s,2\.1\.2-SNAPSHOT</version>,2.1.2</version>, if $inParent and not $done;
$done = $inParent = 1 if /<\/parent>/;
' $(find GeronimoDirectory -name pom.xml | grep -v "GeronimoDirectory/pom.xml")
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
- assemblies/geronimo-boilerplate-minimal/src/main/underlay/etc/gsh-classworlds.conf
- framework/configs/geronimo-gbean-deployer/src/it/j2ee-system-2/src/test/resources/META-INF/geronimo-plugin.xml
- framework/configs/geronimo-gbean-deployer/src/it/j2ee-system-2/src/test/resources/META-INF/plan.xml
- framework/configs/geronimo-gbean-deployer/src/it/j2ee-system/src/test/resources/META-INF/geronimo-plugin.xml
- framework/configs/geronimo-gbean-deployer/src/it/j2ee-system/src/test/resources/META-INF/plan.xml
- framework/configs/geronimo-gbean-deployer/src/it/metadatageneration-2/src/test/resources/META-INF/geronimo-plugin.xml
- framework/configs/geronimo-gbean-deployer/src/it/metadatageneration/src/test/resources/META-INF/geronimo-plugin.xml
- framework/configs/plugin/src/main/plan/plan.xml
- framework/modules/geronimo-plugin/src/test/resources/geronimo-plugins.xml
- framework/modules/geronimo-upgrade/src/test/data/gbean_1.xml
- framework/modules/geronimo-upgrade/src/test/data/gbean_1_result.xml
- plugins/remote-deploy/geronimo-remote-deploy/src/main/webapp/WEB-INF/geronimo-web.xml
- plugins/welcome/geronimo-welcome/src/main/webapp/WEB-INF/geronimo-web.xml
- testsuite/webservices-testsuite/jaxrpc-tests/jaxrpc-war/src/main/webapp/WEB-INF/geronimo-web.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)
- framework/configs/geronimo-gbean-deployer/src/it/j2ee-system/pom.xml
- framework/configs/plugin/pom.xml
- framework/configs/pom.xml
- plugins/j2ee/j2ee-deployer/pom.xml
- plugins/client/pom.xml
- plugins/corba/client-corba-yoko/pom.xml
- plugins/j2ee/j2ee-server/pom.xml
- plugins/pom.xml
- configs/plugin/pom.xml (plugin-repository-list)
- root pom ... pom.xml
- README.txt
- RELEASE_NOTES-*.txt
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:
- assemblies/geronimo-boilerplate-minimal/pom.xml
- framework/configs/plugin/pom.xml
- framework/configs/plugin/src/main/plan/plan.xml
In addition, there are special updates for artifact-alias entries:
- framework/configs/pom.xml
- plugins/client/pom.xml
- plugins/corba/client-corba-yoko/pom.xml
- plugins/pom.xml
Rationale
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.
Steps
- 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.
svn mv SRC-URL DEST-URL -m "Reason for this commit".
- 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:<scm> <connection>scm:svn:http://svn.apache.org/repos/asf/geronimo/specs/tags/geronimo-servlet_2.5_spec-1.1</connection> <developerConnection>scm:svn:https://svn.apache.org/repos/asf/geronimo/repos/asf/geronimo/specs/tags/geronimo-servlet_2.5_spec-1.1</developerConnection> <url>http://svn.apache.org/viewvc/geronimo/repos/asf/geronimo/specs/tags/geronimo-servlet_2.5_spec-1.1</url> </scm> - 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...
<profile> <id>release</id> <build> <plugins> <!-- We want to sign the artifact, the POM, and all attached artifacts --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-gpg-plugin</artifactId> <inherited>true</inherited> <configuration> <passphrase>${gpg.passphrase}</passphrase> </configuration> <executions> <execution> <goals> <goal>sign</goal> </goals> </execution> </executions> </plugin> <!-- We want to deploy the artifact to a staging location for perusal --> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-deploy-plugin</artifactId> <inherited>true</inherited> <configuration> <altDeploymentRepository>${deploy.altRepository}</altDeploymentRepository> <updateReleaseInfo>true</updateReleaseInfo> </configuration> </plugin> </plugins> </build> </profile> - Build the new branches tree as you normally would to ensure that it is correct.
- Stage the release for a vote.
When you are ready to create a release candidate, build the new branches tree that will soon be released using the following command.mvn -Prelease,default deploy
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.
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.
svn export https://svn.apache.org/repos/asf/geronimo/server/branches/2.1.2 geronimo-2.1.2-src tar -zcvf geronimo-2.1.2-src.tar.gz geronimo-2.1.2-src
- Create a distribution directory. It should contain the following artifacts for the vote:
- Source tar & zip
- All assembly images that are part of the vote. This is bot for convenience of the voters and to serve as a distribution location once the vote is complete.
- Release notes, README, LICENSE, NOTICE, and DISCLAIMER
- 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:
signDist.sh
gpg --print-md MD5 ./geronimo-2.1.2-src.tar.gz > ./geronimo-2.1.2-src.tar.gz.md5
gpg --print-md MD5 ./geronimo-2.1.2-src.zip > ./geronimo-2.1.2-src.zip.md5
gpg --print-md MD5 ./RELEASE_NOTES-2.1.2.txt > ./RELEASE_NOTES-2.1.2.txt.md5
gpg --print-md MD5 ./README.txt > ./README.txt.md5
gpg --print-md MD5 ./NOTICE.txt > ./NOTICE.txt.md5
gpg --print-md MD5 ./LICENSE.txt > ./LICENSE.txt.md5
gpg --print-md MD5 ./DISCLAIMER.txt > ./DISCLAIMER.txt.md5
gpg --print-md SHA1 ./geronimo-2.1.2-src.tar.gz > ./geronimo-2.1.2-src.tar.gz.sha1
gpg --print-md SHA1 ./geronimo-2.1.2-src.zip > ./geronimo-2.1.2-src.zip.sha1
gpg --print-md SHA1 ./RELEASE_NOTES-2.1.2.txt > ./RELEASE_NOTES-2.1.2.txt.sha1
gpg --print-md SHA1 ./README.txt > ./README.txt.sha1
gpg --print-md SHA1 ./NOTICE.txt > ./NOTICE.txt.sha1
gpg --print-md SHA1 ./LICENSE.txt > ./LICENSE.txt.sha1
gpg --print-md SHA1 ./DISCLAIMER.txt > ./DISCLAIMER.txt.sha1
gpg --armor --output ./geronimo-2.1.2-src.tar.gz.asc --detach-sig ./geronimo-2.1.2-src.tar.gz
gpg --armor --output ./geronimo-2.1.2-src.zip.asc --detach-sig ./geronimo-2.1.2-src.zip
gpg --armor --output ./RELEASE_NOTES-2.1.2.txt.asc --detach-sig ./RELEASE_NOTES-2.1.2.txt
gpg --armor --output ./README.txt.asc --detach-sig ./README.txt
gpg --armor --output ./NOTICE.txt.asc --detach-sig ./NOTICE.txt
gpg --armor --output ./LICENSE.txt.asc --detach-sig ./LICENSE.txt
gpg --armor --output ./DISCLAIMER.txt.asc --detach-sig ./DISCLAIMER.txtEnsure 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.
- Copy the entire distribution directory to a publicly accessible location. Put it 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.2) and the svn urls to the current source and where the tag will be created.
- 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:mvn stage:copy -Dsource="http://people.apache.org/<your apache id>/staging-repo/<siteId>" \ -Dtarget="scp://people.apache.org/www/people.apache.org/repo/m2-ibiblio-rsync-repository" \ -Dversion=2.1.2 \ -DtargetRepositoryId=apache.releases
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.
From your people apache account copy the distribution content to the appropriate location under /www/www.apache.org/dist/geronimo/Ensure that the files you copy to the rsync directory have
0775dir permission and a0664file permission set on them. - Move the branches to tags using the following command.
svn mv SRC-URL DEST-URL -m "Reason for this commit".
- 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
- Final step is to update the Geronimo Release Roadmaps with the release date.
Notice
The original process in this document was voted on by the Geronimo community. Please formally propose all changes to dev@geronimo.apache.org.
See:
Revised process using maven tools voted on in March 2008. Only major structural changes now require votes.
See: (not yet in archive)