GitHub - hanggrian/java-starters: Common Java project templates
Common Gradle project templates with emphasis on Java, separated by target platform and kind of distribution.
| Plugins | Testing | Publishing | Website | Coverage | Max Heap Size | |
|---|---|---|---|---|---|---|
| android-application | Android | JUnit 4, Robolectric | ✗ | Cayman | ✓ | 4GB |
| android-library | Android | JUnit 4, Robolectric | Maven Central | Javadoc, Minimal | ✓ | 4GB |
| gradle-plugin | Java | JUnit 4 | Plugin Portal | Javadoc, Minimal | ✗ | 2GB |
| jvm-application | Java, Application | JUnit 5 | ✗ | Cayman | ✓ | 2GB |
| jvm-library | Java Library | JUnit 5 | Maven Central | Javadoc, Minimal | ✓ | 2GB |
Frameworks
- JUnit testing framework with Mockito suite and Truth asserter.
- Checkstyle 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:
- 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.