hiranp / java-gradle-template

template for Java Gradle projects with GitHub Actions CI, Codecov, SpotBugs etc. setup

java-gradle-template

template repository for Java projects using Gradle

Features

• JDK 19 (Amazon Corretto)
• Gradle 7
• 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 repository with all the files setup
• Rename the root project (currently java-gradle-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

Build and test

./gradlew spotlessApply build integrationTest

Promise

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