This document is intended to be kept up to date by the Akubra Release Manager. It details the steps necessary to perform snapshot and official releases of Akubra.

Prerequisites

Verify Release Privileges

To perform a release, you must have:

Write access to the Akubra subversion repository hosted at fedora-commons.org. This requires an administrator to add you to the akubra-committer LDAP group.
Write access to the org.akubraproject groupId in the snapshot and staging repositories hosted at oss.sonatype.org. If you don't already have this, you will need to:
- Sign up for a Sonatype OSS account
- Ask the previous release manager to request authorization for this account via the Akubra Project Hosting Ticket
The login details for the fcrelman account at fedora-commons.org. This is only required for official releases, not snapshots. If you don't have this information yet, you can get it from the previous release manager.

Update Maven settings.xml

Akubra's root pom.xml already has the correct staging and snapshot repositories listed in the distributionManagement section. In order to deploy, you will need to add your Sonatype OSS username and password to your local ~/.m2/settings.xml file:

<settings>
  <servers>
    <server>
      <id>sonatype-nexus-snapshots</id>
      <username>YourUsername</username>
      <password>YourPassword</password>
    </server>
    <server>
      <id>sonatype-nexus-staging</id>
      <username>YourUsername</username>
      <password>YourPassword</password>
    </server>
  </servers>
</settings>

Avoid Maven 2.2.0

Make sure you're using a recent version of Maven. As of this writing, the latest was 2.2.1, and it worked fine. In particular, avoid version 2.2.0: it has a serious bug that affects deployments: MNG-4235.

Snapshot Releases

From a clean, up-to-date copy of trunk, run the following command:

mvn clean javadoc:jar source:jar deploy

The snapshot will be immediately available in the public Sonatype repository: http://oss.sonatype.org/content/groups/public

Official Releases

Update KEYS

Make sure the KEYS file at the root of the source tree has your up to date public code signing key and signatures listed. If you don't yet have a code signing key, see Creating a Code Signing Key. When you are ready, append your key with the following command:

(gpg --list-sigs YourKeyID && gpg -a --export YourKeyID) >> KEYS

Do a Dry Run

This step is not required, but performs a useful sanity check without committing any changes. From a clean, up-to-date copy of trunk, run the following command:

mvn release:prepare -DdryRun=true

Tag and Increment Version

This step will set the version declared in the project's pom.xml files, commit the changes to trunk, tag the release, and finally, check in another trunk change that increments the next development version (e.g. x.y-SNAPSHOT) in the pom.xml files.

mvn release:prepare -Dresume=false -Dusername=YourSVNUsername -Dpassword=YourSVNPassword

Note: This may fail to compile part way through the process, complaining that an internal project dependency is not met. If this occurs, don't worry. Just run the following:

mvn install
mvn release:prepare -Dusername=YourSVNUsername -Dpassword=YourSVNPassword

If backing out of this step is needed for any reason, the following will restore the subversion repository and your working copy to the state it was previously in:

mvn release:rollback -Dusername=YourSVNUsername -Dpassword=YourSVNPassword
svn rm https://fedora-commons.org/svn/root/akubra/tags/akubra-x.y

Deploy Artifacts to Staging

This step will push all release artifacts to the staging repository.

Check out the tagged release from subversion and "mvn install" it.
Change back to trunk
mvn release:perform -Darguments="-Dgpg.keyname=YourKeyId -Dgpg.passphrase=YourKeyPassword"

Verify and Promote Staged Artifacts

Log into http://oss.sonatype.org/ UI, click Staging in the left column, then select the staged repository on the right. It will open below. Right click on it and select Close.
Download and test that the artifacts in staging are exactly as they should be once deployed to central.

If anything is incorrect, right click the staged repository and select "Drop". After the problem is resolved, you can re-deploy the artifacts to staging and verify them again. To re-deploy and already-tagged release:

mvn release:perform -Dtag=akubra-x.y -DconnectionUrl=scm:svn:https://fedora-commons.org/svn/root/akubra -Darguments="-Dgpg.keyname=YourKeyId -Dgpg.passphrase=YourKeyPassword"

If everything looks good, right click on the repository and select "Promote". The artifacts should be synced to central within an hour.

Upload Static Documentation

The release:perform step should have created a static maven site for the release (including javadocs) in /tmp/akubra-site. This step will make that documentation available at the appropriate place on the fedora-commons.org website.

cd /tmp
mv akubra-site site
jar -cMf site.jar site
sftp fcrelman@fedora-commons.org
cd documentation/akubra
mkdir x.y
cd x.y
put site.jar
exit
ssh fcrelman@fedora-commons.org
cd documentation/akubra/x.y
jar -xvf site.jar
rm site.jar
exit

Verify the documentation is available at http://fedora-commons.org/documentation/akubra/x.y/site/

Archive the Release

Make a local copy of all the artifacts, checksums, and signatures published to central for this release, putting them in a local directory called akubra-x.y. (If you find a scriptable way to do this, please add it here...)
jar -cMf akubra-x.y.jar akubra-x.y
sftp fcrelman@fedora-commons.org
cd /home/fedcommbkup/release-archive
cd YYYY (e.g. 2010, if it doesn't exist, create it)
mkdir MM-DD (e.g. 03-13, the release date)
cd MM-DD
put akubra-x.y.jar
exit
ssh fcrelman@fedora-commons.org
cd /home/fedcommbkup/release-archive/YYYY/MM-DD
jar -xvf akubra-x.y.jar
rm akubra-x.y.jar
exit

Update the Wiki

Add release notes an update all links on this page.

Child pages

Akubra Release Process