My Conventions

Firstly these are my personal conventions; if you find them useful feel free to let me know and I can migrate them to a stable API. You're welcome to use them either way.

Coverage

This plugin is designed to enforce a minimum coverage percentage per module, and also ensures that all JvmTestSuites are combined so that coverage is calculated across all tests. Instead of providing a ridiculous BigDecimal to the plugin you can simply set a double to the minimum coverage percentage. The default percentage required is 90% or 0.9.

plugins {
  id("com.xenoterracide.gradle.convention.coverage")
}

coverage {
  minimum.set(0.3) // default 0.9
}

Publish

WARNING: this plugin sets up defaults for me, that will not be suitable for your project.

See the package-info

FAQ

Gradle Support

Gradle and Java versions are tested as follows. Older versions may work but are unsupported. Version 1.x starts with Java 11 but may require 17 without notice.

Version	Gradle	Java
v0.2.x	8.x	11.x
v0.3.x	9.x	17.x

Contributing

Languages

asdf is suggested, you can use whatever you'd like to get

• Java 11+
• NodeJs

add a way to export these to your PATH in your ~/.profile

Build Tools

• Gradle
• Yarn 4 (via Corepack)

Fetching Dependencies

In order to get snapshots of dependencies, you must have a GitHub token in your ~/.gradle/gradle.properties file. This file should look like:

ghUsername = <your username>
ghPassword = <your token>

You should generate your PAT as Github Documents here.

a personal access token (classic) with at least read:packages scope to install packages associated with other private repositories (which GITHUB_TOKEN can't access).

Then run.

Yarn setup and manual postinstall:

# Enable Corepack, install Node dev tools, run postinstall, then verify Gradle deps
corepack enable
yarn install --immutable --inline-builds --check-resolutions
yarn run -T postinstall
./gradlew dependencies

If you need to run the postinstall step directly, you can recreate and use the Python lock file via pip-compile (PEP 621):

# Regenerate requirements.txt from PEP 621 dependencies in pyproject.toml
pip-compile -o requirements.txt pyproject.toml

# Then install and set up commit hooks
pip install -r requirements.txt && git config core.hooksPath .config/git/hooks

Committing

Use Conventional Commits.

Licenses

• Java and resulting Jars: GPL-3.0-or-later WITH Classpath-exception-2.0
• Gradle Kotlin and Config Files: MIT
• Documentation including Javadoc: CC-BY-NC-4.0

© Copyright 2024–2025 Caleb Cushing.