will-molloy / java-template

template repo for Java projects using Gradle with everything setup

java-template

template repo for Java projects using Gradle

Features

• JDK 21 (Amazon Corretto)
• Gradle 8
• GitHub Actions CICD
• Automatic code formatting via Spotless
• Code style analysis via Checkstyle
• Static analysis via SpotBugs
• Unit and integration test support via JUnit 5 and TestSets plugin
• Code coverage reporting via Codecov
• Dependency upgrades via Renovate bot

Usage

• Click Use this template
  • This will prompt you to create a new repo with all the files setup
• Rename the root project (currently java-template) and group (currently com.willmolloy) to your liking
• Delete anything you won't use (sub projects, dependencies, etc.)
• Update the README
• Other non-code setup like your GitHub branch protections
• NOTE: if creating a private repo, you probably want to disable the windows and mac builds

Build and test

./gradlew spotlessApply build integrationTest

Upgrade Gradle

• Find the version number on the releases page
  • Java Compatibility Matrix
• Run: ./gradlew wrapper --gradle-version <VERSION> --distribution-type all

Upgrade Java

• Download the JDK using IntelliJ
• Update all references

Promise

• Keep up to date with:
  • Future Java versions
  • Future Gradle versions
  • Other dependency upgrades
  • Any other cool tools or plugins