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. |
Table of Contents |
For lack of a better place at this time, here's some useful pages on Sonatype which detail the Sonatype Maven Release Process: |
major.minor.subminor (e.g. 1.6.0)
The one exception is that the Language Packs (dspace-api-lang
and dspace-xmlui-lang
) use the numbering convention major.minor.subminor.sequence-number (e.g. 1.6.0.0). This allows us to release new versions of the language packs more frequently than normal DSpace releases.
To perform a release, you must have all of the following:
hkp://pgp.mit.edu
, as this is the Key Server Sonatype uses for verification:
(e.g.) {{gpg --keyserver hkp://pgp.mit.edu --send-keys \[yourKeyID\]}} |
Here's notes from Mark Diggory on how to give someone else access to the OSUOSL server (projects.dspace.org):
~/.ssh/authorizedkeys
(make sure permissions are correct on file)maven:x:4002:peterdietz,esm,mdiggory,tdonohue,ben,kim,apache |
umask 002
is in the users ~/.bash_profile
so maven permissions are written correctly.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 xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <servers> <!--Login info for Sonatype SnapShot repository--> <server> <id>sonatype-nexus-snapshots</id> <username>YourSonatypeUsername</username> <password>YourSonatypePassword</password> </server> <!--Login info for Sonatype Staging/Release repository--> <server> <id>sonatype-nexus-staging</id> <username>YourSonatypeUsername</username> <password>YourSonatypePassword</password> </server> <!--Login info for DSpace Projects (projects.dspace.org) website @OSUOSL--> <server> <id>website</id> <username>YourOSUOSLUserName</username> <privateKey>[Full-path-to]\.ssh\id_rsa</privateKey> <passphrase>YourKeyPassphrase (if necessary)</passphrase> </server> </servers> </settings> |
If you don't yet have a ~/.m2/settings.xml
file, you should create one, and copy the full contents above (obviously make sure to put in your username and password).
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. Maven 2.1.0 also is problematic, as it produces improper GPG signatures.
For more information see the Pre-Requisities section of theSonatype Maven Repository Usage Guide
From a clean, up-to-date copy of trunk, run the following command:
mvn clean javadoc:jar source:jar deploy
You will have to enter in your GPG passphrase (which you established when you created your Code Signing Key).
The snapshot will be immediately available in the public Sonatype repository: http://oss.sonatype.org/content/groups/public
These same steps are also covered in the Sonatype Maven Repository Usage Guide |
If possible, you should release the DSpace Language Packs (i18n modules) before the main release. Oftentimes, it's best to release these one or two days prior to the DSpace release (that way they've already propagated out to the Maven repository).
At the moment the i18n modules are maintained in SVN under the modules
folder:
http://scm.dspace.org/svn/repo/modules/
There are currently two i18n modules you will need to release:
dspace-api-lang
dspace-xmlui-lang
Note that the version numbering convention for Language Packs is always the same as the current DSpace release, with an additional .<sequence-number> (e.g. the i18n modules for the 1.6.0 release are numbered as follows: 1.6.0.0, 1.6.0.1, etc.) |
For each module, perform the full release steps that follow. To save space, the steps are only listed for one of the modules (but don't forget to run it for both language packs):
svn co https://scm.dspace.org/svn/repo/modules/dspace-api-lang/trunk dspace-api-lang
mvn release:prepare -DdryRun=true
mvn release:prepare -Dresume=false
mvn release:perform
Once the Language Packs are released, you may need to modify the DSpace Parent pom.xml (http://scm.dspace.org/svn/repo/dspace/trunk/pom.xml) to reference the new version of the Language Packs. This should be similar to the following:
If possible, you'd only want to commit this after the i18n modules are available in the Maven Repository. But, if you are in a rush, you can commit this change earlier (though be warned that this will break the build process for anyone who hasn't manually installed the i18n modules to his/her local ~/.m2/
directory).
In the main pom.xml, provide the proper version range for each language pack. In the below example, we are saying to use any language pack version which is at least version 1.6.0.0, but is less than version 1.7.0.0:
<dependency> <groupId>org.dspace</groupId> <artifactId>dspace-api-lang</artifactId> <version>[1.6.0.0,1.7.0.0)</version> </dependency> <dependency> <groupId>org.dspace</groupId> <artifactId>dspace-xmlui-lang</artifactId> <version>[1.6.0.0,1.7.0.0)</version> <type>war</type> </dependency> |
Make sure the latest Wiki-based Documentation has been exported as HTML and PDF and committed to [dspace-src]/dspace/docs/ in SVN.
It's often easier to completely remove all current HTML content before committing the updated HTML content. Because of the HTML directory structure exported by Confluence, it can be very difficult to determine which files need removing (especially old attachments). So, you may want to completely remove the old HTML directory, before committing the updated content. An example follows:
|
Make sure that the contents of all README, LICENSE, NOTICE files are up-to-date in SVN. Most of these files exist in one of two main locations:
If anything is out-of-date, make sure to update it and commit the proper changes before continuing.
Checkout a copy of the to-be-release version either from a branch or trunk.
svn co https://scm.dspace.org/svn/repo/dspace/trunk dspace-release |
This step is not required, but performs a useful sanity check without committing any changes. From your 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).
If you notice an issue or an error occurs, you can re-run the Dry Run using the following command:
|
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.z-SNAPSHOT) in the pom.xml files.
mvn release:prepare -Dresume=false |
(Optionally, you may also include the parameters -Dusername=YourSVNUsername -Dpassword=YourSVNPassword
at the end of the above command, though I've not found these to be necessary)
The above command will ask you three basic questions. Here are sample answers for DSpace 1.6.0:
"What is the release version for: XXX" 1.6.0 "What is SCM release tag or label for: XXXX" dspace-1.6.0 "What is the new development version for: XXXX" 1.6.1-SNAPSHOT |
You will also have to enter in your GPG passphrase (which you established when you created your Code Signing Key).
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:
|
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:
|
This step will sign, checksum, and push all release artifacts (including javadocs and sources) to the Sonatype staging repository (http://oss.sonatype.org/). Run the following:
mvn release:perform |
You should be prompted by Maven to specify your GPG passphrase (which you established when you created your Code Signing Key). If you run into any issues, it's possible to specify your GPG key and passphrase as arguments to the above command (e.g. -Darguments="-Dgpg.keyname=YourKeyId -Dgpg.passphrase=YourKeyPassword"
)
If any errors or problems occur during the deploy, you can re-run |
For screenshots and more details on this step, visit the Sonatype Repository Usage Guide's section on Releasing your artifacts |
If anything is incorrect, select 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: |
The previous actions will have checked out the release tag into the target directory under {{\[dspace-src\]/target/checkout}}. Navigate to that directory and execute the creation of the distributions using the following command. This will create two zip, bzip and gzipped files in the target directory. One set of files is the "binary" release, and the other set is the source release. |
(Note: If you've already removed the target/checkout
directory, you can also checkout a fresh copy of the newly tagged version and run this command from the DSpace parent directory.)
localhost$ cd target/checkout localhost$ mvn package -Pdistributions [INFO] Scanning for projects... [INFO] ---------------------------------------------------------------------------- [INFO] Building DSpace Parent Project [INFO] task-segment: [package] [INFO] ---------------------------------------------------------------------------- [INFO] [site:attach-descriptor] [INFO] [assembly:single -(execution. default-)] [INFO] Building zip: .../target/dspace-1.5.0-beta1-release.zip [INFO] Building tar: .../target/dspace-1.5.0-beta1-release.tar.gz [INFO] Building tar: .../target/dspace-1.5.0-beta1-release.tar.bz2 [INFO] Building zip: .../target/dspace-1.5.0-beta1-src-release.zip [INFO] Building tar: .../target/dspace-1.5.0-beta1-src-release.tar.gz [INFO] Building tar: .../target/dspace-1.5.0-beta1-src-release.tar.bz2 [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ |
Upload both the source and binary releases to Sourceforge.net. You can either upload them via the web interface, or copy them over via scp
or other command line tools. If you want to copy the files from command line, follow the directions found here: http://apps.sourceforge.net/trac/sourceforge/wiki/File%20management%20service
Using scp
to copy to the "DSpace Stable" file directory: (example for 1.6.0 final)
(NOTE: You will need to first create the 'DSpace Stable/1.6.0' directory via SourceForge's Admin UI)
scp <files> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Stable/1.6.0/" |
Using scp
to copy to the "DSpace Release Candidate" file directory: (example for 1.6.0-rc2)
(NOTE: You will need to first create the 'DSpace Release Candidate/1.6.0-rc2' directory via SourceForge's Admin UI)
scp <files> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Release\\ Candidate/1.6.0-rc2/" |
You must wait for all the packages to be available at http://repo2.maven.org/maven2/org/dspace/ before you announce the release. Until the DSpace packages are available in the Maven repository, no one else will be able to build DSpace using Maven. |
If you encounter one of these errors when building/packaging DSpace:
FATAL ERROR: "Reason: Could not find the model file '../dspace-xmlui-lang'. for project unknown"
OR
FATAL ERROR: "Reason: Could not find the model file '../dspace-api-lang'. for project unknown"
This is a known bug in Maven. The problem is that you likely have a 'dspace-xmlui-lang' or 'dspace-api-lang' folder at the same level as your \[dspace-source\] parent folder. Essentially, Maven located them and tried to add them into the build process (which it shouldn't have). The fix is to completely delete the 'dspace-xmlui-lang' and 'dspace-api-lang' folders, and try to rebuild DSpace. |