Release Numbering Convention

As of 2012 (starting with 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)

• Major Releases: incrementing the first number ('major') will represent a new MAJOR release of DSpace. A major release may include any or all of the following: new features, system improvements, architectural changes, bug fixes. All major releases end in ".0", so "3.0", "4.0", and "5.0" would all represent major releases.
• Minor (Bug-Fix) Releases: incrementing the second number ('minor') will represent a new MINOR release of DSpace. A minor release will only include bug fixes to an existing major release. For example, "3.1" and "3.2" would represent two minor releases which only include bug fixes to the "3.0" major release..

For more information see DSpace Release Numbering Scheme

Prerequisites

Verify Release Privileges

To perform a release, you must have all of the following:

1. Write access to the DSpace GitHub repository hosted at https://github.com/DSpace/DSpace. (All Committers should already have this, obviously)
2. Write access to the org.dspace groupId in the snapshot and staging repositories hosted at oss.sonatype.org.  If you don't already have this, you will need to:
   
   1. Sign up for a Sonatype JIRA account. This account will also serve as your login to the Sonatype OSS system. (If you already have a Sonatype account, you can skip this step)
   2. Ask a Committer with release privileges (e.g. a previous release manager) to request that your Sonatype account be given release privileges to the "org.dspace" GroupID. This request should be submitted via the Sonatype JIRA system in the Open Source Project Repository Hosting project.
   3. Once Sonatype gives you the proper authorization, you should be able to login to the Sonatype OSS system using the same login/password you setup in Sonatype JIRA. You should also have access to publish new releases to the "org.dspace" GroupID.
   4. NOTE: The full details of signing up and getting access to Sonatype are also posted online here: Sonatype Maven Repository Usage Guide
3. You must generate and publish your own personal Code Signing Key (required by Sonatype). Here are two sites that give hints on how to do that:
   
   • Creating a Code Signing Key
   • How to Generate PGP Signatures with Maven (required for all Sonatype releases)
   • Make sure to publish your Key file to 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]
       

       • [yourKeyId] can be found by running the following command and copying the alpha-numeric string after the "/" on the "pub" line 

         • gpg --list-keys
           

     • You can see if your key is already on that Key Server by visiting http://pgp.mit.edu and searching on your name

Update Maven settings.xml

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>ossrh</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).

Maven settings to release DSpace < 6

With DSpace 6 we changed the maven plugin that pushes our releases to Sonatype. The configuration above is correct beginning with DSpace 6. In case you release a previous DSpace version, you'll need to copy the server section two times and change the id to sonatype-nexus-snapshots and sonatype-nexus-staging. A settings file that allows you to release all versions of DSpace would look like the following 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>ossrh</id>
      <username>YourSonatypeUsername</username>
      <password>YourSonatypePassword</password>
    </server>
    <!--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>

While it may look surprisingly that you have to add the same credentials three times, DSpace < 6 will be looking for these server IDs and the upload to sonatype will fail as unauthorized if they are missing.

Using SSH and GPG agents

During a release you have to type the passwords of your GPG and SSH keys very often. Every DSpace module produces several files, all have to be signed and transfered to Sonatype. GPG and SSH agents help you to avoid typing passwords again and again. To use an ssh-agent just start it, export the required environment variables and add your ssh-key. To use a gpg agent start it, export the required environment variables and add the following to your ~/.m2/settings.xml:

<settings>
...
  <profiles>  
    <profile>
      <id>gpg-profile</id>
      <properties>
        <gpg.useagent>true</gpg.useagent>
        <!-- If you have gpg2 instead, you can tell Maven to use it instead of 'gpg' by uncommenting the following -->
        <!--<gpg.executable>gpg2</gpg.executable>-->
      </properties>
    </profile>
  </profiles>
...
</settings>

On each maven run it may ask you once about your password which is a big improvement.

Java Version

For DSpace 7.x, you must use Java 11.

For DSpace 6.x, you can use Java 8.
For DSpace 5.x, you should be using Java 7 and running Maven with "-Dhttps.protocols=TLSv1.2" to avoid errors as described at https://stackoverflow.com/a/50924208/3750035

• Unfortunately even disabling `doclint` on these branches seems to not be enough (See https://github.com/DSpace/DSpace/issues/6509), so you really do need to find an old version of Java 7 around somewhere.

• If you are using a recent version of Ubuntu, OpenJDK 7 is harder and harder to find. However, there are still some PPAs that have unmaintained copies (i.e. no security patches). This is good enough for installing on something like vagrant-dspace just do perform the release. Here's a PPA that has worked (as of July 2017):

  # Install the add-apt-repository command (if not available)
  sudo apt install software-properties-common
  # Add a PPA that has old 7 versions of OpenJDK
  sudo add-apt-repository ppa:openjdk-r/ppa
  sudo apt-get update
  # Install OpenJDK 7
  sudo apt-get install openjdk-7-jdk
  # Switch which Java alternative is in use (and select OpenJDK 7)
  # OBVIOUSLY, YOU SHOULD MAKE SURE TO SWITCH BACK AFTER THE RELEASE IS COMPLETE
  update-alternatives --config java
  # Check that the settings are now correct
  java -version

Use Maven 3 or above

Make sure you're using a recent version of Maven. As of this writing, Maven 3.0.5 is known to work.

For more information see the Prerequisites section of the Sonatype Maven Repository Usage Guide

For DSpace 7.x, you must use Maven 3.3 or above.  However, Maven 3.5.4 or above is highly recommended, as it's necessary to regenerate the LICENSES_THIRD_PARTY file (see notes below)

Unset MAVEN_OPTS, if you use it

If you normally use a MAVEN_OPTS environment variable on the machine you're using to cut the release, be sure to unset it, with this command:

unset MAVEN_OPTS

It's highly unlikely the configuration in your MAVEN_OPTS will be useful for the release. It's highly likely to cause problems. Better to be safe.

Making a Snapshot Release (e.g. 'dspace-x.y-SNAPSHOT')

One Step Process

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: https://oss.sonatype.org/content/repositories/releases/org/dspace/

Releasing a Single Module/Project

• If you'd like to release a Snapshot Release of that module, follow the instructions at: Making a Snapshot Release (e.g. 'dspace-x.y-SNAPSHOT')
• If you'd like to tag & release a new version of that module, use the module instructions at: Release DSpace Language Packs (I18N) Modules (NOTE: These instructions obviously have some specific notes around how the Language Packs modules are versioned. You obviously don't need to follow those versioning notes. Individual modules may have their own version schemes)

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

The Day Before:  Double Check Contents of all README (and similar) files in GitHub

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.

Request any CVEs from GitHub (if security fixes are included)

If this release includes fixes to any draft security advisories, make sure to request CVEs from GitHub as early as you can.  As of 2022, GitHub's policies currently say they will respond within 3 working days.  Since the announcement of the release requires the CVEs, you'll want to make sure that you have the CVEs assigned as early as reasonably possible.

(Keep in mind requesting CVEs does NOT make the security advisories public.  They will not become public until you publish them.  We recommend not publishing the security advisories until the release is already completed and the announcement is about to go out.)

Regenerate the LICENSES_THIRD_PARTY file

The "LICENSES_THIRD_PARTY" file is now autogenerated via a Maven command (using the codehaus license-maven-plugin). Simply run the following from your local source directory to re-generate this file:

# Install latest version of all dependencies in local cache
# (Only necessary if you haven't run this recently)
mvn -U clean install

# Regenerate LICENSES_THIRD_PARTY file
mvn verify -Dthird.party.licenses=true

On completion, a new, updated version of the LICENSES_THIRD_PARTY file will be written to your source directory. Please double check this file or "git diff" it to see if the changes look reasonable. Here are some things to especially be on the lookout for:

• If any dependencies are listed with an "UNKNOWN" license, then that means that dependency failed to specify its OS License in their own Maven POM file. We will need to manually lookup the license for that project, and manually add it to our src/main/license/LICENSES_THIRD_PARTY.properties file which corrects all "UNKNOWN" licenses. Finally, rerun the command above to regenerate the new LICENSES_THIRD_PARTY based on this update.
• If any dependencies are listed under an INCOMPATIBLE License (GPL, AGPL, etc), then we need to take a closer look at that dependency.  It is possible that the dependency is dual-licensed and therefore may be listed multiple times in the generated LICENSES_THIRD_PARTY file. If so, that's fine. If not, we may need to remove that dependency prior to the release.
• If any Open Source Licenses are listed under multiple names (e.g. "BSD" vs. "BSD License" vs. "BSD licence"), then we may need to update our POM configurations for the codehaus license-maven-plugin to tell it to merge licenses of those names into one. Those configurations are in the Parent POM under the <licenseMerges> tag of this plugin: https://github.com/DSpace/DSpace/blob/master/pom.xml#L406

If the file was updated, commit it.

Final Commits & Preparation

Release DSpace Language Packs (I18N) Modules

Before performing an official 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. (Also required for 7.x and above!)
• dspace-xmlui-lang - Check if any new commits have occurred on 'dspace-xmlui-lang' since the last release. (For v6.x or below only)

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):

1. Checkout the Language Pack Module:
   

   1. git clone git@github.com:DSpace/dspace-api-lang.git dspace-api-lang


   2. cd dspace-api-lang

   3. git checkout main 
      NOTE: always release language packs from the main branch -- we do not use a maintenance branch for language packs.

2. Do a Dry Run: mvn release:prepare -DdryRun=true
3. Tag and Increment Version: mvn release:prepare -Dresume=false
   
   • Make sure to assign a version number of the format: [major].[minor].[sequence-number] (e.g. 5.0.0, 5.0.1, etc for 5.0 releases of language packs)
   • NOTE: The release process should suggest the correct version number by default
4. Deploy Artifacts to Staging in Sonatype: mvn release:perform
5. Verify and Release Staged Artifacts in Sonatype (see instructions at link)
6. (For v6.x or below) Go back and run steps #1-5 above for the other language packs modules (dspace-xmlui-lang)

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.

Double Check Language Packs' Version Ranges

Once the Language Packs are released, you will probably 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>

Ensure Documentation is Updated Appropriately

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:

• Release Notes- Should contain a very basic overview of the Release. Make sure the Release number is updated here!
  
  • NOTE: For minor releases (bug-fix-only releases), you may want to leave all information about the previous major release, and just enhance the content to state that this was a bug-fix release, and list any new contributors, etc.
• Installation - Obviously make sure the Installation Documentation is updated for this Release
• Upgrading a DSpace Installation - Same for the Upgrade Documentation, make sure it's up to date
• History- Make sure the online History for this latest Release is included. You should be able to just copy the last version's page and update the version numbers. For example, copy the previous release's page, and change as follows:
  
  • You'll notice all the JIRA history is generated via the 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.

Ensure you tag multiple releases in chronological order!

If you are performing multiple releases at once (e.g. backporting security or bug fixes), it is IMPORTANT to tag your releases chronologically.  For example, the backported fixes to 3.x should be tagged BEFORE 4.x which should be tagged BEFORE 5.x. The reason for this is that the timestamp of the tag determines the ORDERING of the releases in GitHub.  So, in order for the 5.x release to appear after the backported releases, it needs to be released LAST.  The last tagged release will become the "Latest Release" in GitHub.

Warning: optional profiles need to be specified at compile time

Just including a little warning about this up front. The following optional modules need to be specified with every mvn command below. We will make an effort to keep this list up to date, but you should verify it before you cut a new release. Things change. Forgetting an optional module means you'll have to cut another release.

mvn {target} {-D[version-specific-option]}

# NOTE: for DSpace 7.x, you MUST use the "-Drelease" flag in all commands.  It will automatically release all modules.
# NOTE: for DSpace 6.x, make sure the "-Dmirage2.on=true" flag is specified to ensure Mirage2 is released
# NOTE: for DSpace 5.x, make sure the "-Dmirage2.on=true" flag is specified to ensure Mirage2 is released 
#       AND the LNI module must be manually specified (-Pdspace-lni)
#       AND "-Dhttps.protocols=TLSv1.2" (needed for Maven + Java 7)

Checkout Main or Branch to Release

Checkout a fresh copy of the to-be-released version either from a branch or main. For example:

git clone git@github.com:DSpace/DSpace.git dspace-release
cd dspace-release
git checkout main

Note: do not just re-use an old working copy of the DSpace Main 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 main 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)

Update your Local Maven Cache (optional - not necessary)

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 -Dmirage2.on=true
# NOTE: for DSpace 5.x, the LNI module must be manually specified (-Pdspace-lni)
# Additionally, if releasing using Java 7, then you must include "-Dhttps.protocols=TLSv1.2" to avoid protocol_version errors in Maven.

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.

Do a sanity check of the tests

You know, just to save yourself a bunch of embarrassment later, run the tests?

mvn test -Dmaven.test.skip=false -DskipITs=false

You can also choose to simply verify the tests succeed in our automated CI processes after the latest commit.

Do a Dry Run

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]):

# For DSpace 6.x or below
mvn release:prepare -DdryRun=true -Dmirage2.on=true
# NOTE: for DSpace 5.x, the LNI module must be manually specified (-Pdspace-lni) to ensure it is also released.
# Additionally, if releasing using Java 7, then you must include "-Dhttps.protocols=TLSv1.2" to avoid protocol_version errors in Maven.

# For DSpace 7.x or above (the "-Drelease" flag is required and it selects all modules to release)
mvn release:prepare -DdryRun=true -Drelease

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 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]):

# For DSpace 6.x or below
mvn release:prepare -Dresume=false -Dmirage2.on=true
# NOTE: for DSpace 5.x, the LNI module must be manually specified (-Pdspace-lni) to ensure it is also released
# Additionally, if releasing using Java 7, then you must include "-Dhttps.protocols=TLSv1.2" to avoid protocol_version errors in Maven.

# For DSpace 7.x or above (the "-Drelease" flag is required and it selects all modules to release)
mvn release:prepare -Dresume=false -Drelease

(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).

What do successful tagging results look like?

Assuming everything worked right, you should see ALL the following changes in GitHub:

1. A newly tagged version of DSpace under: https://github.com/DSpace/DSpace/tags
   
   1. For example, if you are releasing "3.2" you should see a newly listed tag "dspace-3.2" in the list of tags above.
2. The primary "pom.xml" file in that newly tagged version should have a <version> tag that correspond to the newly released version.
   
   1. For example, if you are releasing "3.2", then the "dspace-3.2" tag's main "pom.xml" should have a <version>3.2</version> tag
3. The primary "pom.xml" file in the original branch ("master" or a ".x" branch) should now be updated to the next SNAPSHOT version
   
   1. For example, if you are releasing "3.2", then the original "dspace-3.x" branch's pom.xml file should now have a <version>3.3-SNAPSHOT</version> tag

4. 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] ------------------------------------------------------------------------

What to do if you get tagging Errors?

Deploy Artifacts to Staging in Sonatype

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]):

# For DSpace 6.x or below
mvn release:perform -Dmirage2.on=true
# NOTE: for DSpace 5.x, the LNI module must be manually specified (-Pdspace-lni) to ensure it is also released
# Additionally, if releasing using Java 7, then you must include "-Dhttps.protocols=TLSv1.2" to avoid protocol_version errors in Maven.

# For DSpace 7.x or above (the "-Drelease" flag is required and it selects all modules to release)
mvn release:perform -Drelease

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")

Verify and Release Staged Artifacts in Sonatype

1. Login to http://oss.sonatype.org/
2. Click "Staging Repositories" in the left column, then select the checkbox next to the staged repository on the right. The contents of it will open up at the bottom of the page.
   1. The staged repository should begin in the "Closed" state, which means some automated verifications on the POM structure etc. have already been run. If it is not yet closed, select it and click the "Close" button.

3. Ensure that the artifacts in staging are exactly as they should be once deployed to Maven Central.  Here's a few things to watch out for...

   1. Download one (or more) of the POMs, and make sure the <version> tag is correct (e.g. 6.0 and not a SNAPSHOT version or similar)

   2. Compare it against a past release in Maven Central (https://search.maven.org/search?q=org.dspace), making sure it has the same JARs or WARs, etc

   3. Check if the file sizes looks reasonable (0 Bytes is probably not reasonable ;-)). You can also compare those to previous releases.

   4. You can also verify the checksums of one or more of the JARs/WARs in Sonatype versus those that were installed into your .m2 directory. They should be the same.

      If You Need to Revert Back before Releasing

      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:
      mvn release:perform -Dmirage2.on=true -Dtag=dspace-x.y -DconnectionUrl=scm:git:git@github.com:DSpace/DSpace.git -Darguments="-Dgpg.keyname=YourKeyId -Dgpg.passphrase=YourKeyPassword"

4. If everything looks good, select the repository and select "Release". The artifacts should be synced to Maven central (https://search.maven.org/search?q=org.dspace) within 2 hours.

   Once Released, There is No "Undo" Option

   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.

   1. Keep in mind however, that the release should become almost immediately available in the public Sonatype repository: https://oss.sonatype.org/content/repositories/releases/org/dspace/

Create the Distribution Zips

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, two bzip and two gzipped files in the target directory. One set of files is the "binary" release, and the other set is the source release.

# NOTE: for DSpace 5.x, the LNI module must be manually specified (-Pdspace-lni) to ensure it is also distributed
# Additionally, if releasing using Java 7, then you must include "-Dhttps.protocols=TLSv1.2" to avoid protocol_version errors in Maven.

localhost$ cd target/checkout/dspace/
localhost$ mvn package -Pdistributions -Dmirage2.on=true
 [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] ------------------------------------------------------------------------

Release the Frontend (UI) via a GitHub Release Tag

1. Create a new Release & Tag in GitHub.  See https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository for full instructions
   • Note: Alternatively, you can choose to tag the release from command-line (via git tag), but GitHub allows you to create a new tag when creating a new release.
   • Just create a new tag (e.g. "dspace-7.0") off the current "main" branch.
2. Make sure the GitHub Release description links to the Release Notes  It should also link to the Backend's GitHub Release (and visa versa).  Look at past 7.x releases for examples.

Create the PDF version of Wiki Documentation

Export the latest Wiki-based Documentation as PDF.

Create a new GitHub release & upload distribution files

• From the GitHub UI, visit: https://github.com/DSpace/DSpace/releases
• Find the newly tagged release & click on "Add Release Notes"
• Add in some basic release notes (refer to prior versions for some standard text).  Please be sure to provide the following information:
  • A link to the Wiki Release Notes (in the DSDOC area)
  • A link to the general documentation for this release (again in the DSDOC area)
• Upload the distribution files and a PDF export of the documentation. There should be 7 total files attached:
  • dspace-[version]-release.tar.gz
  • dspace-[version]-release.tar.bz2
  • dspace-[version]-release.zip
  • dspace-[version]-src-release.tar.gz
  • dspace-[version]-src-release.tar.bz2
  • dspace-[version]-src-release.zip
  • DSpace-Manual.pdf
• When you are satisfied, publish the new release!

Update demo.dspace.org

• For 6.x, see demo.dspace.org Notes
• For 7.x, see Updating DSpace 7 Demo Sites

Build Docker Images for Tagged Releases

Images can be built & pushed from command-line to DockerHub.  Again, use the same tag name (e.g. "dspace-7.0") as above.

Tim & Kim currently have Push access.  Request it from one of them if you don't have it yet.

cd <DSPACE-SRC>
--checkout tag--
docker build -t dspace/dspace:<tag> .
docker push dspace/dspace:<tag>

cd <ANGULAR-SRC>
--checkout tag--
docker build -t dspace/dspace-angular:<tag> .
docker push dspace/dspace-angular:<tag>

After the Release is Finished

• Make sure all contributors to the release have been added to the Release Notes!
• Coordinate Announcements with LYRASIS Staff:
  
  • You might post draft announcements to a service such as https://gist.github.com/ and send out a call to committers for review.  When finalized, DSpace releases should be announced on the dspace-community, dspace-devel and dspace-tech lists/groups.
  • Announcement on dspace.org, twitter
  • (As necessary) Ensure that the Latest Release page on dspace.org is updated.
    
    • Plus, ask dspace.org admins to upload latest documentation in PDF/HTML format
  • Announce on all DSpace mailing lists
  • Link announcement on Home of DSpace Wiki, change any version numbers listed on that page.
• Update Wiki pages, particularly these pages which refer to the Current and Next Releases:
  
  • Current Release
  • Next Release Status
  • Releases
  • NOTE: See DSpace Wiki Style Guide for notes on how to actually edit the above Redirect pages
• Also, update the Documentation Wiki area! Specifically:
  
  • All Documentation page -> Has current release info
  • Add a warning to the documentation of the newest unsupported release (e.g. the warning for DSpace 1.7) and link to our Support Policy.
    Spaces - Space directory - (i) next to the space - Space Admin - Themes - Configure Theme - Header 
  • Homepage for the current Documentation (e.g. DSpace 6.x Documentation) -> Has links to download latest version of DSpace
  • Update the database schema diagram
• For major releases, create a new branch in GitHub for any upcoming bug-fix releases:
  
  • E.g., after the 3.0 release, we created a 3.x branch for any subsequent bug fix releases.
  • To automatically create a branch, you may be able to use the release:branch command (NOTE: untested, but it should work! once we test it out, this may be the best practice way of creating a branch).

  • 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 main checkout, and make sure to update its version numbers in the pom.xml files by running the following:

    git checkout main
    mvn release:update-versions

    (Remember to enter in the next appropriate major version number. E.g. After releasing 3.0, main should be updated to "4.0-SNAPSHOT", while the new 3_x branch should be at "3.1-SNAPSHOT")

  • NOTE: the 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.
  • Push your verified changes back to GitHub.
  • You'll also need to ensure that all version numbers and the <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.
• Updates to GitHub: 
  • Move any uncompleted PRs to the next DSpace version tag / project board
  • Close the release milestone (adding date of the release)
• Find the contributors (helpful data for the announcement, you are drafting an announcement, right?): 

  • For bugfix releases

    # This example is to find the list of contributors to 6.3 
    # It lists contributors to 6.x branch since the 6.2 tag
    git shortlog -ns dspace-6_x ^dspace-6.2

  • For major releases (or from main branch), you can use GitHub contributors pages with a date range.  
    • Find date of last major release (e.g. 6.0 was released on Oct, 24, 2016)
    • Use contributors graph to find contributors between 6.0 and 7.0, e.g. https://github.com/DSpace/DSpace/graphs/contributors?from=2016-10-24&to=2021-07-29&type=c

Possible Errors you may Encounter

"Could not find model file" error (with language packs)

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.

Advice for future Release Coordinators

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.