How to define a variable for all Gradle subprojects using Gradle Kotlin DSL

Question

I am following this guide.

The guide reads: Extra properties on a project are visible from its subprojects. This does not seem to work for me, as the following does not work:

In build.gradle.kts I have:

val ktorVersion by extra("1.3.2")

In subproject/build.gradle.kts I have:

dependencies {
    implementation("io.ktor:ktor-server-core:$ktorVersion")
}

ckunder · Accepted Answer · 2020-07-17T22:14:01.640

25

In the project level build.gradle.kts:

val ktorVersion by extra { "1.3.2" }

In the subproject/build.gradle.kts:

val ktorVersion: String by rootProject.extra

dependencies {  
   implementation("io.ktor:ktor-server-core:$ktorVersion")
}

For more info: Gradle docs on Extra properties

edited Jul 17 '20 at 22:14

answered Jul 17 '20 at 21:40

ckunder

1,920
1
10
10

1

I don't understand. Why would the documentation say: "Extra properties on a project are visible", if that's not the case? – Philippe Jul 18 '20 at 13:56
Not really what I wanted, but close enough – Philippe Sep 26 '20 at 14:35
this looks ugly, because you declare variable two times... – user924 Jul 15 '22 at 10:06

sedovav · Answer 2 · 2022-10-27T14:56:48.493

13

Also, you may define the versions in an object inside the buildSrc project. buildSrc is a special project in Gradle, all declarations from it are visible across all Gradle projects (except settings.gradle.kts). So you may have

buildSrc/src/main/kotlin/myPackage/Versions.kt

object Versions {
  const val ktorVersion = "1.2.3"
}

And then use it from any your build.gradle (.kts) files

import myPackage.Versions.ktorVersion

dependencies {
  implementation("io.ktor:ktor-server-core:$ktorVersion")
}

UPD: currently recommended way to solve this problem is to use https://docs.gradle.org/current/userguide/platforms.html

dependencies {
    implementation(libs.groovy.core)
    implementation(libs.groovy.json)
    implementation(libs.groovy.nio)
}

edited Oct 27 '22 at 14:56

answered Jul 18 '20 at 12:15

sedovav

1,986
1
17
28

This is cleaner. The other option is fugly. – jimmy_terra Nov 06 '20 at 01:36
This is cleaner since we don't have to redeclare `ktorVersion` on sub-projects. – HendraWD Jun 22 '21 at 03:23
7

Cleaner but might be slower because update of ANY version in buildSrc/src/main/kotlin/myPackage/Versions.kt will cause gradle to recompile build scripts. See https://melix.github.io/blog/2021/03/version-catalogs.html – sergeidyga Sep 19 '21 at 09:53

How to define a variable for all Gradle subprojects using Gradle Kotlin DSL

2 Answers2