Skip to end of metadata
Go to start of metadata

The CloudSync software is currently distributed via Maven Central, with the help of Sonatype's OSS Hosting.

On this page:

Prerequisites

  • As a CloudSync committer, you should have permission to deploy to Sonatype. If you don't yet, create a Sonatype account for yourself, then contact an existing committer. Tell them your userid and ask them to request access on your behalf by submitting a comment to the DuraSpace hosting ticket at Sonatype.
  • Update your system-wide maven settings.xml file (usually found at ~/.m2) with your Sonatype credentials, like so:
    <settings>
      <servers>
        <server>
          <id>sonatype-nexus-snapshots</id>
          <username>YOUR-SONATYPE-USERNAME</username>
          <password>YOUR-SONATYPE-PASSWORD</password>
        </server>
        <server>
          <id>sonatype-nexus-staging</id>
          <username>YOUR-SONATYPE-USERNAME</username>
          <password>YOUR-SONATYPE-PASSWORD</password>
        </server>
        ..
      </servers>
      ..
    </settings>
    
  • 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

Snapshot Releases

A snapshot release can be performed any time via:

mvn clean deploy

The artifacts will be immediately available at https://oss.sonatype.org/content/repositories/snapshots/org/duraspace/fcrepo-cloudsync

Official Releases

First, stage the release (substitute the appropriate version number below).

mvn release:clean
mvn release:prepare -Dtag=v0.0.0
# If the above fails due to missing dependencies,
# run it again after first running 'mvn install'
git pull
git checkout v0.0.0
mvn clean install
git checkout master
mvn release:perform

Then release the staging repository:

  • Login to oss.sonatype.org
  • Find the staging repo
  • Select, then close it
  • Select, then release it

The artifacts will be synced to central within a few hours. You can check by browsing to http://central.maven.org/maven2/org/duraspace/fcrepo-cloudsync/.

Documentation Updates

CloudSync documentation is organized such that each feature release has its own wiki space, with an id named after that release. For example, CloudSync 1.0's space is CLOUDSYNC10. CloudSync 5.5's space would be CLOUDSYNC55. Bugfix releases don't trigger the creation of a new space. Instead, the details about the latest bugfix release are added to the appropriate feature releases's space. For example, CloudSync 1.0.1 would be discussed in the CLOUDSYNC10 space.

When a feature release or major release occurs, a full copy of the previous feature release's space should be made, then updated with the name and other details pertaining to the new release. You can create this copy by going to the top-level page of the previous feature release's space, then selecting "Copy into new Space" in the Tools menu on the upper right.

For any release, the release notes should be updated to include detail about each bugfix or feature new to that release. In addition, the Downloads page should be updated to link to the latest version of the software. Installation and other documentation should also be updated as needed.

Finally, in the left navigation for each CLOUDSYNCXY documentation space, there are links to the documentation for the most recent releases. When a new documentation space is added, these links must be updated manually by going into the "Space Admin" screen under the Browse menu, then selecting "Themes" on the left, then "Configure Theme".

  • No labels