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

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
• NPM

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.

Run npm ci && ./gradlew dependencies to install dependencies.

Committing

Use Conventional Commits.

Licenses

• Java and resulting Jars: Apache-2.0
• Gradle Kotlin and Config Files: MIT
• Documentation including Javadoc: CC-BY-NC-4.0

© Copyright 2024 Caleb Cushing.