cgspace-java-helpers/README.md

3.1 KiB

CGSpace Java Helpers GitHub Actions

DSpace curation tasks and other Java-based helpers used on the CGSpace institutional repository:

  • CountryCodeTagger: add ISO 3166-1 Alpha2 country codes to items based on their existing country metadata
  • FixJpgJpgThumbnails: fix low-quality ".jpg.jpg" thumbnails by replacing them with their originals
  • FixLowQualityThumbnails: remove low-quality thumbnails when PDF bitstreams are present
  • NormalizeDOIs: normalize DOIs by stripping whitespace, lowercasing, and converting to https://doi.org/ format

Tested on DSpace 7.6. Read more about the DSpace curation system.

Build and Install

Integrate into DSpace Build

To use these curation tasks in a DSpace project add the following dependency to dspace/modules/additions/pom.xml:

<dependency>
  <groupId>io.github.ilri.cgspace</groupId>
  <artifactId>cgspace-java-helpers</artifactId>
  <version>7.6.1.2-SNAPSHOT</version>
</dependency>

The jar will be copied to all DSpace applications.

Manual Build and Install

To build the standalone jar:

$ mvn package

Copy the resulting jar to the DSpace lib directory:

$ cp target/cgspace-java-helpers-7.6.1.2-SNAPSHOT.jar ~/dspace/lib/

Configuration

Please refer to the appropriate README.md file:

TODO

Notes

This project was initially created according to the Maven Getting Started Guide:

$ mvn -B archetype:generate -DgroupId=io.github.ilri.cgspace -DartifactId=cgspace-java-helpers -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4

To deploy a new -SNAPSHOT release to Maven Central (make sure OSSHRH credentials are in ~/.m2/settings.xml):

$ mvn clean deploy

See: Performing a Snapshot Deployment

License

This work is licensed under the GPLv3.

This repository contains data from the Debian iso-codes project project, which is licensed under the GNU Lesser General Public License v2.1.