Groovy Starters

Common Gradle project templates with emphasis on Groovy, separated by target platform and kind of distribution.

	Plugins	Testing	Publishing	Website	Coverage	Max Heap Size
gradle-plugin	Groovy	JUnit 4	Plugin Portal	Groovydoc, Minimal	✗	2GB
jvm-application	Groovy, Application	JUnit 5	✗	Cayman	✓	2GB
jvm-library	Groovy	JUnit 5	Maven Central	Groovydoc, Minimal	✓	2GB

Frameworks

• JUnit testing framework with Mockito suite and Truth asserter.
• CodeNarc code linter with third-party ruleset Rulebook.
• JaCoCo code coverage.

Project layout

• Root directory:
  • GitHub README, LICENSE, and gitignore file.
  • EditorConfig enforces IDE settings.
• GitHub Actions workflows:
  • Run tests, linters and push coverage to Codecov.
  • Activate Renovate bot to alert out-of-date dependencies.
• Gradle build tool:
  • Kotlin DSL scripts with properties delegation.
  • Apply plugin using plugins DSL.
  • Version catalogs in TOML file to avoid typing unsafe dependencies.
• Website module:
  • Pages Gradle Plugin for generating webpage displaying README's content and documentation links.
  • gradle-git-publish plugin, necessary for uploading to GitHub Pages.