Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current ·  View Page History
<< Previous Version 80 Next >>

Releases are now performed using Maven 2 so you need to have Maven 2 installed (see the building page). This page describes how the release process is handled.

Organization

CARGO is made of four main modules (i.e., trunks):

  • pom: That is the parent of all CARGO modules.
  • resources: Contains resources, most notably the CARGO ping component as well as the test WARs.
  • core: CARGO Java implementation.
  • extensions: CARGO extensions, i.e. the ANT, Maven and Maven2 tasks/plugins.

These four modules might evolve at different speeds, and if one module has not changed at all it then does not need to be released. In most cases, one would expect the pom and resources to change rarely.

CARGO uses the Codehaus Nexus instances for release, which means that we release in two phases:

  1. The Maven2 release plugin will actually release to a staging area, i.e. the generated artifacts are only available on the staging repository
  2. Once the staged version is OK (to confirm by opening a vote on the CARGO developers list, for example), it can be promoted (therefore, deployed to the Maven2 central repository)

As a consequence of that release cycle thing, release has to be done in three phases:

  1. If the parent has changed, release the parent without using the "staging" phase. To do so, log in to the Codehaus Nexus interface directly (without waiting for a vote) and release.
  2. For resources, core and extensions:
    • Release all three at once
    • This will indeed create a big "staging" repository
    • Open the vote so the whole team can decide whether the artifacts are OK
    • Once the vote is finished, promote the release

Prerequisites

In order to release, you will need:

  • An access to the Codehaus Nexus instance as a manager for the CARGO project. Read more about it on Codehaus Maven Repository Usage Guide
  • The GNU privacy guard (GPG) installed on your machine and at least one secret key.
  • To provide your Codehaus Xircles credentials using your settings.xml file (in the ${user.home}/.m2/ directory). Here's an example settings.xml:

Before you start

Before releasing, make sure what is going to be released is fully functional. In particular, run the core/samples using the all-downloadable profile (mvn clean install -Pall-downloadable).

  • The Continous Integration for CARGO actually passes tests for all containers. Green ones are doing well (smile)
  • If any container is not passing, move it to the all-unstable-downloadable list.
  • Make sure all containers in the all-stable-downloadable profile pass the samples.

Tagging and deploying on to the staging area

  1. Check if there have been SVN commits on that artifact since the latest stable release. If there have been, you'll need to release.
    • The parent and resources typically don't change between versions.
  2. In the artifact's topmost pom.xml, if there are links to other trunks (core/pom.xml contains a property called cargo.resources.version, for example), update these to the latest release
  3. Release the code trunk
  4. In the artifact's topmost pom.xml, change the links to the other trunks' versions to the new SNAPSHOT version
  5. Start by erasing your local Maven repository (${user.home}/.m2/repository/, unless you've reconfigured this in your settings.xml). This will ensure that you don't have any artifacts cached locally that can't be found in public repositories.
  6. The typical Maven release procedure is to execute these commands for each trunk (i.e. repeat this for each trunk):
    1. A dry-run before doing the actual release to ensure there aren't any problems:
      mvn clean release:prepare -DdryRun=true
    2. mvn release:prepare : the actual release preparation, with the actual tagging process
        • If the Subversion commit fails, try executing the same command but add -Dusername=your_user_name -Dpassword=your_password (of course, replace with your own user name and password on the CARGO SCM)
    3. mvn release:perform : deploys the tagged artifacts on the Codehaus Nexus staging repository
      • If you're running on Maven 2.2.0 (note: that's the version that ships with some flavors of MacOS X), you might run into SHA1 and MD5 signature verification issues. Please upgrade to Maven 2.2.1.
      • If you get a message saying: Error deploying artifact: Failed to transfer file. Return code is: 401 Unauthorized, please make sure your credentials in the settings.xml file are correct.

Sometimes, the Maven2 release plugin has trouble releasing the core module (the compiler seems to fail). In order to release manually, follow these steps:

  1. Go to the core/target/checkout folder
  2. Run mvn clean deploy -Drelease=true -DperformRelease=true -Pcodehaus-release in order to deploy the CARGO core artifacts to the Codehaus Nexus repository
  3. Run mvn site-deploy in order to deploy the CARGO documentation to the CARGO web site

Sometimes, you might get a message saying Error deploying artifact: Failed to create destination WebDAV collection (directory): unable to find valid certification path to requested target, that's because the Codehaus HTTPS WebDAV servers' certificate is not installed on your computer. In this case:

  1. Download and compile the program from http://blogs.sun.com/andreas/resource/InstallCert.java
  2. Execute the program java InstallCert dav.codehaus.org and make it install one of the certificates. If you run the program again, it should be happy and tell you that all certificates are installed.
  3. Add the generated jssecacerts file to your $JAVA_HOME/jre/lib/security directory.

Promoting the staged version

Once the new CARGO version is in the Codehaus Nexus staging repository, send an e-mail to the CARGO list so users can try out the new version. We typically leave the vote open for 72 hours.

Once the developers/users also validate the version as being stable, we need to to the actual release:

  1. Follow the guide on closing a staging repository on Codehaus Nexus and releasing a closed staging repository on Codehaus Nexus in order to release the CARGO artifacts to Maven2 central.
  2. Log onto Cargo JIRA, release the current version and add the next version.
  3. Check that the Cargo wiki is up to date. Specifically, perform the following updates:
    1. Modify the status on the home page about the delivery:
      • Make sure the Containers list is complete
      • Make sure the Navigation page is complete
      • Make sure the Javadocs for the Core Containers are complete
      • Make sure the documentation for each container is up to date. The source files (that you need to copy-paste in each container's page manually) are generated in core/documentation/target/[container's name].log.
    2. Move the old version to the Archived Downloads page
      • Remember to move the old documentation archive from the Downloads page to that page as well
    3. Modify the Home and Downloads pages to update the download links, available version number and release note links
    4. Export the wiki to a zipped HTML file (select all pages except for the Downloads page) and add it the Downloads page
  4. Send an announcement email to Cargo mailing lists ... and to other relevent sites you know about. Mailing lists of some servers can also be interesting.
  5. Create a blog post
Labels
  • None