Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Making an Official Release (e.g. 'dspace-1.7.0' or 'dspace-1.7.0-rc1')

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:

...

Note
titleFor More Information

These same steps are also covered in theSonatype Maven Repository Usage Guide

Info

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

You will have to enter in your GPG passphrase (which you established when you created your Code Signing Key).

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

(Optionally, you may also include the parameters -Dusername=YourSVNUsername -Dpassword=YourSVNPassword, though I've not found these to be necessary)

You will have to enter in your GPG passphrase (which you established when you created your Code Signing Key).

Info
titleIf you receive a project dependency error

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
Note
titleBacking out of changes

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.yImage Added

Deploy Artifacts to Staging

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

  1. Check In a separate directory, check out the newly-tagged release from subversion and "mvn install" it.
  2. Change Now, go back to the directory which has your checkout of 'trunk' (which was used in the above steps)
  3. Run, mvn release:perform
    • If your GPG Code Signing Key isn't found by Maven, you may need to specify your GPG code signing key and passphrase as arguments to the above command: -Darguments="-Dgpg.keyname=YourKeyId -Dgpg.passphrase=YourKeyPassword"
    • By default, Maven should just prompt you to specify your GPG passphrase.

Verify and Promote Staged Artifacts

...