Skip to content

karmakrafts/karma-conventions

Repository files navigation

Karma Conventions

Gradle conventions plugin for Karma Krafts projects.
This plugin provides many utilities, including but no limited to:

  • Git integration
  • GitLab Package Registry integration
  • GitLab CI integration
  • URL encoding
  • Configuring the Java version
  • java.nio.file.Path extensions
  • Coverage
  • Publishing defaults & extensions
  • Signing
  • Network connectivity
  • Kotlin target extensions (for JVM & Multiplatform)
  • Kotlin CInterop extensions
  • Documentation generation using Dokka

How to use it

First, add the official Maven Central repository to your settings.gradle.kts:

pluginManagement {
    repositories {
        mavenCentral()
    }
}

Then add a dependency on the plugin in your root buildscript:

plugins {
    id("dev.karmakrafts.conventions.karma-conventions") version "<version>"
}