This document is intended to be kept up to date by the DSpace Release Managers.  It details the steps necessary to perform snapshot and official releases of DSpace and supporting Modules.

Prerequisites

Verify Release Privileges

To perform a release, you must have:

• Write access to the DSpace subversion repository hosted at http://scm.dspace.org/svn/repo; This requires an administrator to add you to the svn repository permissions via the TRAC user group.
• Write access to the org.adspace 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 DSpace Project Hosting Ticket

Update Maven settings.xml

DSpace's root pom.xml already has the correct staging and snapshot repositories listed in the OSS parents 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.

Making a Snapshot Release

One Step

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

Making an Official Release

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:

1. mvn install
2. 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:

1. mvn release:rollback -Dusername=YourSVNUsername -Dpassword=YourSVNPassword
2. svn rm https://scm.dspace.org/svn/repo/dspace/tags/dspace-x.y

Deploy Artifacts to Staging

This step will sign, checksum, and push all release artifacts (including javadocs and sources) to the staging repository.

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

Verify and Promote Staged Artifacts

1. 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.
2. 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 an already-tagged release:

• mvn release:perform -Dtag=dspace-x.y -DconnectionUrl=scm:svn:https://scm.dspace.org/svn/repo/dspace -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.

(acknowledge this shameless copy and paste from Akubra Release Process)