gradle-codeowners-plugin

2.8.0indexed

Enhances build processes by propagating CODEOWNERS information to classes. Offers plugins for reporting class ownership, JVM runtime propagation, and Kotlin runtime propagation, supporting multi-module projects.

JSJVMNative·gmazzo/gradle-codeowners-plugin

Stars

—

Used by

dependents

—

Health

/ 100

GitHub

gradle-codeowners-plugin

A Gradle plugin to propagate CODEOWNERS attribution to Kotlin or JVM classes

It consists on 3 different plugins, each one providing a different set of features and targeting different use cases:

Usage

This plugin is designed to work as a whole build plugin, but you can selectively apply it to target the modules where you actually care about CODEOWNERS propagation.

The simplest setup is to apply the plugin at the root project, and then to each submodule. At root build.gradle.kts add:

plugins {
  id("io.github.gmazzo.codeowners") version "<latest>"
}

subprojects {
  apply(plugin = "io.github.gmazzo.codeowners")
}

You should apply the right plugins according to your needs:

io.github.gmazzo.codeowners (Report) is for the generating codeowners-like file by Java/Kotlin classes names
io.github.gmazzo.codeowners.jvm (JVM) is for propagating codeowners info to JVM-only projects
io.github.gmazzo.codeowners.kotlin (Kotlin) (recommended) is for propagating codeowners info to for **pure Kotlin ** projects (including JVM and multiplatform)

(*) inherited from io.github.gmazzo.codeowners (Report) plugin
(**) because how the Java Resources API on JVM the ownership information may be inaccurate in some cases. See Caveats on the approach for more details.

Getting ownership information at runtime

Later, you can query a class's owner by:

val ownersOfFoo = codeOwnersOf<Foo>()

or in Java:

Set<String> ownersOfFoo = CodeOwners.getCodeOwners(Foo.class);

Crash attribution

Expections can also be attributed by inspecting its stacktrace (first match wins)

try {
  // do some work

} catch (ex: Throwable) {
  val ownersOfErr = ex.codeOwners
  // report to its owner
}

or in Java:

try {
  // do some work

} catch (Throwable ex) {
  Set<String> ownersOfErr = CodeOwners.getCodeOwners(ex);
  // report to its owner
}

Ownership attribution checks

The codeOwnersReport task (bounded to the check lifecycle one) that can be used to produce a report of unowned class files or even fail the build.

You can enable and configure it as follows:

codeOwners {
  reports {
    failOnUnowned()
  }
}

Check reports for more details.

Recommended setup on multi module projects

At root's build.gradle.kts add:

plugins {
  id("io.github.gmazzo.codeowners") version "<latest>"
}

subprojects {
  apply(plugin = "io.github.gmazzo.codeowners")
}

You must apply the plugin on every project that has source files. Those classes won't be computed otherwise. Applying it at the root project only, will only make sense on single module builds.

The CODEOWNERS file

The expected format is the same as GitHub's and it can be located at any of the following paths:

$rootDir/CODEOWNERS
$rootDir/.github/CODEOWNERS
$rootDir/.gitlab/CODEOWNERS
$rootDir/docs/CODEOWNERS

Specifying CODEOWNERS file location

codeOwners.codeOwnersFile.set(layout.projectDirectory.file("somePath/.CODEOWNERS"))

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

kopy★ 296

JavierSegoviaCordobaFacilitates deep copying and updating of data class properties using `copy` or `invoke` functions. Adds new functions and properties, supports lambda updates, and enhances immutability without reflection.Shared: kotlin-dsl, kotlin-compiler-plugin, gradle-plugin

EzHook★ 48

XDMrWuAOP framework enabling method replacement at compile-time through custom hooks. Offers runtime support, original method invocation, and inlining for reduced dependency issues. Supports specific platforms.Shared: kotlin-compiler-plugin, gradle-plugin, compiler-plugin

inspekt★ 43

rnettCompile-time reflection enabling inspection of classes, functions, properties and annotations, with top-level declaration support, suspend invocation, JVM-like proxies and dependency reflection.Shared: kotlin-compiler-plugin, gradle-plugin, compiler-plugin

kotlin-dynamic-delegation★ 42

Him188A compiler plugin enabling dynamic class delegation similar to property delegations, which simplifies delegation and allows functions to be 'lazy' with persistent values, enhancing flexibility and reducing boilerplate.Shared: kotlin-dsl, kotlin-compiler-plugin, compiler-plugin

aspectk★ 22

Mole-LabsCompile-time aspect-oriented weaving via compiler IR transformation, injecting @Aspect/@Before advice with zero runtime overhead; supports suspend, inline, extension, expect/actual functions, inheritance, many-to-many targets, rich JoinPoint metadata.Shared: kotlin-compiler-plugin, gradle-plugin, compiler-plugin

kotlin-all-static★ 2

kyay10Enhances code by automatically applying the `@JvmStatic` annotation to all functions and properties within objects and companion objects, simplifying interoperability and static member access.Shared: kotlin-compiler-plugin, gradle-plugin, compiler-plugin

Generates class-like reports at build time	✅	✅ *	✅ *
Propagates codeowners info to runtime	❌	✅	✅
Works with JVM projects	✅	✅	✅
Works with Multiplatform projects	❌	❌	✅
Acurrancy: Codeowners info matches always the original file ones	🟢	🟡 **	🟢