Step by step of how to perform a Release via Maven |
This document is intended to be kept up to date by the DSpace Release Team. 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: |
As of 2012 (DSpace 3.0), DSpace has moved to a new release numbering scheme/format. Release numbers will now only consist of two numbers.
Release Numbering Scheme: [major].[minor]
(e.g. 3.0, 3.1, 3.2, 4.0)
For more information see DSpace Release Numbering Scheme and the initial DSpace 3.0 Announcement
The one exception is that the Language Packs ( |
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:gpg --keyserver hkp://pgp.mit.edu --send-keys [yourKeyID]
[yourKeyId]
can be found by running the following command and copying the alpha-numeric string after the "/" on the "pub" line
gpg --list-keys
DSpace's root pom.xml already has the correct staging and snapshot repositories listed in the OSS parent's '<distributionManagement>' section. In order to deploy, you will need to add your Sonatype OSS username and password to your local ~/.m2/settings.xml
file. For example:
<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> </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, Maven 3.0.3 or 3.0.4 is known to work.
For more information see the Prerequisites section of the Sonatype Maven Repository Usage Guide
From a clean, up-to-date copy of master/branch, 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 |
Before performing a main release, you should see if the DSpace Language Packs (i18n modules) need an updated release. The easiest way to check if they need to be released it by checking to see if any commits have occurred since the previous release (see below for links). Please note that you can release these I18N Modules on the same day as the main DSpace release. The DSpace parent pom.xml is now configured to also check Sonatype's Release Repository for any Maven artifacts (so you do NOT need to wait for the I18N modules to appear in Maven Central)
At the moment the i18n modules are maintained in two separate GitHub projects. There are currently two i18n modules you will need to release:
dspace-api-lang
- Check if any new commits have occurred on 'dspace-api-lang' since the last release.dspace-xmlui-lang
- Check if any new commits have occurred on 'dspace-xmlui-lang' since the last release.Note that the version numbering convention for Language Packs is always the same as the current DSpace release, with an additional |
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):
git clone git
@github
.com:DSpace/dspace-api-lang.git dspace-api-lang
cd dspace-api-lang
git checkout master
NOTE: always release language packs from the master branch, we do not use a maintenance branch for language packs.
mvn release:prepare -DdryRun=true
mvn release:prepare -Dresume=false
[major].[minor].[sequence-number]
(e.g. 3.0.0, 3.0.1, etc for 3.0 releases of language packs)mvn release:perform
Once both Language Packs have been released, you can immediately perform the DSpace release. You do not need to wait for them to appear in Maven Central, as our DSpace parent pom.xml will find them in Sonatype's Release Repository immediately.
Once the Language Packs are released, you may need to modify the DSpace root pom.xml (https://github.com/DSpace/DSpace/blob/master/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 3.0.0, but is less than version 4.0.0:
<!-- DSpace Localization Packages --> <dependency> <groupId>org.dspace</groupId> <artifactId>dspace-api-lang</artifactId> <version>[3.0.0,4.0.0)</version> </dependency> <dependency> <groupId>org.dspace</groupId> <artifactId>dspace-xmlui-lang</artifactId> <version>[3.0.0,4.0.0)</version> <type>war</type> </dependency> |
Hopefully, you've already been talking with others about getting Documentation updated!
You should also double check that the following "main pages" are updated in the Documentation:
jiraissue
plugin. In the url
argument for that plugin, you should find the DSpace version number embedded in the querystring like: "... AND+fixVersion+%3D+%223.0%22 ..." If you look closely, you'll see the 'fixVersion' is set to "3.0" in that search string. All you should need to do is update that version number (and the plugin will now search for tickets closed for 4.0)Also make sure to update the title
argument for that jiraissue
plugin to list the proper version number information
Obviously, this is just a brief reminder of important areas of Documentation which always require updates. There's surely other areas, like Configuration section, which will require some updates for your release. |
Make sure that the contents of all README, LICENSE, LICENSES_THIRD_PARTY, NOTICE files are up-to-date in GitHub. These files reside in [dspace-src]. If anything is out-of-date, make sure to update it and commit the proper changes before continuing.
Pay close attention to the "LICENSES_THIRD_PARTY" file. You should attempt to determine if any third-party dependencies were added or removed and update their licensing information in this file. Information on the Maven commands that may come in handy when updating this file can be found in the Notes at the end of the "LICENSES_THIRD_PARTY" file.
Checkout a fresh copy of the to-be-released version either from a branch or master. For example:
git clone git@github.com:DSpace/DSpace.git ~/dspace-release cd ~/dspace-release git checkout master |
Note: do not just re-use an old working copy of the DSpace Master branch, for obvious reasons, you don't want your own work in progress sneaking into the release. It's also important to use the SSH repository path as noted above (NOT the https URL), otherwise you will be prompted for your GitHub credentials during the release process. More than once. Save yourself some time, be sure to use the SSH path.
Note: if you are doing a maintenance release, you will need to check out the maintenance branch, and not the master branch. In this case, the example above would instead read:
git clone git@github.com:DSpace/DSpace.git ~/dspace-release cd ~/dspace-release git checkout dspace-3_x (or whatever the current maintenance branch might be named) |
Before starting the release, you may wish to ensure your local maven cache (~/.m2/repository
) is completely up-to-date by running (from [dspace-src]
):
mvn install |
Updating your local maven cache will help to ensure that the release process goes more smoothly, and should help you to avoid any errors having to do with Maven being unable to locate any particular dependencies. That being said, this step actually may not be necessary, if our release process is working correctly.
This step is not required, but performs a useful sanity check without committing any changes. From your clean, up-to-date copy of master/branch, run the following command (from [dspace-src]
):
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:
You can also clean up any of the release files that the Dry Run created, and just re-run it.
|
This step will set the version declared in the project's pom.xml files, commit the changes to master/branch, tag the release, and finally, check in the master/branch change that increments the next development version (e.g. x.y-SNAPSHOT) in the pom.xml files. Run the following (from [dspace-src]
):
mvn release:prepare -Dresume=false |
(Optionally, you may also include the parameters -Dusername=YourGitHubUsername -Dpassword=YourGitHubPassword
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 3.0:
|
You will also have to enter in your GPG passphrase (which you established when you created your Code Signing Key).
As the release process scrolls by, you likely will see a LOT of "WARNING" messages. Don't worry, these should be just Javadocs warnings, and can be safely ignored. Just be patient, and see if it all succeeds in the end. |
Assuming everything worked right, you should see ALL the following changes in GitHub:
The results from Maven look similar to this. (Don't worry about the "SKIPPED" messages, those are normal, as the actual release process just runs from the "DSpace Parent Project")
[INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary: [INFO] [INFO] DSpace Parent Project ............................. SUCCESS [2.320s] [INFO] DSpace Services Framework :: API and Implementation SKIPPED [INFO] DSpace Kernel :: API and Implementation ........... SKIPPED [INFO] DSpace Addon Modules .............................. SKIPPED [INFO] DSpace Kernel :: Additions and Local Customizations SKIPPED [INFO] DSpace XML-UI (Manakin) ........................... SKIPPED [INFO] DSpace XML-UI (Manakin) :: Local Customizations ... SKIPPED [INFO] DSpace LNI ........................................ SKIPPED [INFO] DSpace LNI :: Local Customizations ................ SKIPPED [INFO] DSpace JSP-UI ..................................... SKIPPED [INFO] DSpace JSP-UI :: Local Customizations ............. SKIPPED [INFO] DSpace SWORD ...................................... SKIPPED [INFO] DSpace SWORD :: Local Customizations .............. SKIPPED [INFO] DSpace SWORD v2 ................................... SKIPPED [INFO] DSpace SWORD v2 :: Local Customizations ........... SKIPPED [INFO] DSpace SOLR :: Local Customizations ............... SKIPPED [INFO] DSpace OAI 2.0 .................................... SKIPPED [INFO] DSpace OAI 2.0 :: Local Customizations ............ SKIPPED [INFO] DSpace Assembly and Configuration ................. SKIPPED [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ |
The
|
If backing out of this step is needed for any reason, the following will restore the github 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 (from [dspace-src]
):
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 |
Download and test that the artifacts in staging are exactly as they should be once deployed to central.
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: |
If everything looks good, select the repository and select "Release". The artifacts should be synced to Maven central (http://repo2.maven.org/maven2/org/dspace/) within 2 hours.
Once you select "Release", there is no way to "undo" the release. If any major issues are found, you'll have to increment the version number and perform a new bug-fix release. |
The previous actions will have checked out the release tag into the target directory under [dspace-src]/target/checkout/dspace/
. 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-src]/dspace/
directory.)
localhost$ cd target/checkout/dspace/ localhost$ mvn package -Pdistributions [INFO] Scanning for projects... [INFO] [INFO] ---------------------------------------------------------------------------- [INFO] Building DSpace Assembly and Configuration 3.0 [INFO] ---------------------------------------------------------------------------- .... [INFO] --- maven-assembly-plugin:2.2.1:single (default) @ dspace --- [INFO] Reading assembly descriptor: src/main/assembly/release.xml [INFO] Reading assembly descriptor: src/main/assembly/src-release.xml [INFO] Building zip: [full-path-to-dspace-src]/dspace/target/dspace-3.0-release.zip [INFO] Building tar: [full-path-to-dspace-src]/dspace/target/dspace-3.0-release.tar.gz [INFO] Building tar: [full-path-to-dspace-src]/dspace/target/dspace-3.0-release.tar.bz2 [INFO] Building zip: [full-path-to-dspace-src]/dspace/target/dspace-3.0-src-release.zip [INFO] Building tar: [full-path-to-dspace-src]/dspace/target/dspace-3.0-src-release.tar.gz [INFO] Building tar: [full-path-to-dspace-src]/dspace/target/dspace-3.0-src-release.tar.bz2 [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ |
Export the latest Wiki-based Documentation as PDF.
See this DSpace documentation management guide: How To Export Downloadable Docs from Wiki |
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. You should expect a few minutes' delay before the individual files become visible on SourceForge.
Using
scp
to copy to the "DSpace Stable" file directory: (example for 3.0 final)
(NOTE: You will need to first create the 'DSpace Stable/3.0' directory via SourceForge's Admin UI)
scp <files> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Stable/3.0/" scp <documentation_pdf> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Stable/3.0/DSpace-Manual.pdf" |
Using
scp
-r to copy to the "DSpace Release Candidate" file directory: (example for 3.0-rc1)
(NOTE: You will need to first create a folder in your target directory, named "3.0-rc1" or whatever the name of the release is, and then mv all the tar.gz and zip files to that folder... you're going to recursively scp the entire contents of that folder to Sourceforge)
scp -r <release_folder_with_zips> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Release\\ Candidate/" scp <documentation_pdf> <username>,dspace@frs.sourceforge.net:"/home/frs/project/d/ds/dspace/DSpace\\ Release\\ Candidate/DSpace-Manual.pdf" |
See the procedure .
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. |
To manually create a branch, run commands similar to:
git clone git@github.com:DSpace/DSpace.git branchit cd branchit git checkout -b dspace-3_x dspace-3.0 git push --set-upstream origin dspace-3_x |
Then, go back to your master
checkout, and make sure to update its version numbers in the pom.xml files by running the following:
git checkout master mvn release:update-versions |
(Remember to enter in the next appropriate major version number. E.g. After releasing 3.0, master
should be updated to "4.0-SNAPSHOT", while the new 3_x
branch should be at "3.1-SNAPSHOT")
update-versions
command doesn't always work perfectly. You will want to try a complete rebuild of DSpace before committing anything, as it sometimes misses updating a few version numbers.<scm>
section is appropriate in the pom.xml files of your new Branch. Remember, the <scm>
configurations should point at the branch, rather than back at master
.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.
With a straight face assure the next Release Coordinator that 'Maven is easy' and there is nothing to be afraid of, then put your feet up and open a beer.