Skip to main content

Shared Libraries

We have a couple of shared libraries that were written in house to standardise Kotlin projects and provide solutions to some common problems.

Spring Boot Gradle plugin

The Kotlin template brings in our Gradle Plugin in its build.gradle.kts buildscript.

This is a build plugin used to provide a common Gradle build for all of our Kotlin projects. Its main features are:

  • keeping projects up to date on the latest Spring Boot version
  • adding Spring Web, Spring Actuator and Spring Test to projects
  • applying the Spring BOM to manage dependency versions
  • providing standard build tools such as KTLint, a vulnerability checker, a version updater

Tips

  • Use the KTLint helper tasks to make sure your code is formatted before committing. Otherwise, you’ll find builds failing on your CI server due to KTLint format errors.
  • Use command ./gradlew useLatestVersions to update your dependencies and build plugins to latest versions.
  • If you find a CVE vulnerability in your project, search for the CVE reference number in the release notes for the Gradle plugin to see if the CVE has been dealt with.

HMPPS Kotlin Library

The Kotlin template uses our Kotlin library which provides solutions to some common patterns used in HMPPS.

Look at the components section of the readme to see what is provided.

NOTE The library provides basic Spring Security by default, so be aware that you’ll need to acquire some client credentials for calling your API.