PDF service client

This is a client library for pdf-service, which allows to generate read-only PDFs based on given template in HTML/Twig format and placeholder data in JSON format.

This library is hosted on Azure DevOps Artifacts and can be used in your project by adding the following to your build.gradle file:

repositories {
 maven {
   url = uri('https://pkgs.dev.azure.com/hmcts/Artifacts/_packaging/hmcts-lib/maven/v1')
 }
}

dependencies {
  implementation 'com.github.hmcts:pdf-service-client:LATEST_TAG'
}

Getting started

Prerequisites

• JDK 17

Building

The project uses Gradle as a build tool but you don't have to install it locally since there is a ./gradlew wrapper script.

To build project please execute the following command:

    ./gradlew build

Developing

Unit tests

To run all unit tests please execute following command:

    ./gradlew test

Coding style tests

To run all checks (including unit tests) please execute following command:

  ./gradlew check

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

To release a new version add a tag with the version number and push this up to the origin repository. This will then build and publish the release to maven.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.