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

java-template's Issues

IDEA inspections

Just see https://github.com/JetBrains/inspection-plugin

Will allow stuff like:

• final fields

to be checked

(i.e. stuff checkstyle, spotbugs, etc. doesn't pick up)

Github actions

Use Github actions instead of travis ci

concerns

• Still in beta (as of 2019/11/05)
• not free for private repos
• might break codecov

SonarCloud/SonarQube

SonarCloud: https://sonarcloud.io
SonarQube: https://www.sonarqube.org/

Would replace CodeCov with their coverage tool, and also provide transparent quality checks (e.g. via. FindBugs).

Implementation requires modification of the current CI setup.

Tool that allows users to pull updates to template

Gradle Kotlin DSL

https://www.thoughtworks.com/radar/languages-and-frameworks?blipid=202203041

Docker package example

Copy the approach taken in https://github.com/will-molloy/auto-handbrake-encoding to publish a docker package.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update all dependencies (com.google.guava:guava, com.github.spotbugs)

Detected dependencies

github-actions

.github/workflows/build.yml

• actions/checkout v4
• actions/setup-java v4
• codecov/codecov-action v4
• actions/checkout v4
• actions/setup-java v4
• codecov/codecov-action v4
• actions/checkout v4
• paulhatch/semantic-version v5.4.0
• softprops/action-gh-release v2.0.5

gradle

gradle.properties

settings.gradle.kts

build.gradle.kts

• com.diffplug.gradle.spotless 6.25.0
• com.github.spotbugs 6.0.15
• com.asarkar.gradle.build-time-tracker 4.3.0
• org.apache.logging.log4j:log4j-core 2.23.1
• com.github.spotbugs:spotbugs-annotations 4.8.5
• com.google.guava:guava 33.2.0-jre
• org.junit.jupiter:junit-jupiter 5.10.2
• com.google.truth:truth 1.4.2
• org.mockito:mockito-core 5.12.0
• org.mockito:mockito-junit-jupiter 5.12.0

hello-world/build.gradle.kts

• org.unbroken-dome.test-sets 4.1.0

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

---

• Check this box to trigger a request for Renovate to run again on this repository

Integrate Error Prone

see https://errorprone.info/