Ministry of Justice Digital Prison Reporting Glue Jobs

CODEOWNER

• Team : hmpps-digital-prison-reporting
• Email : digitalprisonreporting@digital.justice.gov.uk

Overview

Provides code defining a number of jobs to be launched by AWS Glue supporting a number of processes within the Digital Prison Reporting platform.

Local Development

This project uses gradle which is bundled with the repository.

Running a job

First, build the jar locally

    ./gradlew clean build

and then execute the job by specifying the fully qualified classname e.g.

    java -cp ./build/libs/gradle-demo-app-1.0-SNAPSHOT.jar uk.gov.justice.digital.Placeholder

Unit Tests

The unit tests use JUnit5 and Mockito where appropriate. Use the following to run the tests.

    ./gradlew clean test

Integration Tests

    TBD

Acceptance Tests

    TBD

Contributing

Please adhere to the following guidelines when making contributions to the project.

Documentation

• Keep all code commentary and documentation up to date

Branch Naming

• Use a JIRA ticket number where available
• Otherwise a short descriptive name is acceptable

Commit Messages

• Prefix any commit messages with the JIRA ticket number where available
• Otherwise use the prefix NOJIRA

Pull Requests

• Reference or link any relevant JIRA tickets in the pull request notes
• At least one approval is required before a PR can be merged

TODO

• Modify the Dependabot file to suit the dependency manager you plan to use and for automated pull requests for package updates. Dependabot is enabled in the settings by default.
• Ensure as many of the GitHub Standards rules are maintained as possibly can.