build config: Gradle Version Catalog + type-safe project dependencies #2884

aSemy · 2023-02-22T10:07:58Z

Moves versions out of gradle.properties and into libs.versions.toml version catalog
Uses type-safe project dependencies for internal projects
refactor the maven-cli downloader convention plugin (added in Refactor Maven Runner build config #2911) to use the version catalog, and for clarity
Additionally updates JUnit to 5.9.2

Depends on #2652

Goooler

Good to see! We can migrate to type-safe project accessors in next PR.

Goooler · 2023-02-22T12:51:55Z

gradle/libs.versions.toml

+kotlin-plugin = "213-1.8.10-release-430-IJ6777.52"
+kotlinx-coroutines = "1.6.3"
+kotlinx-html = "0.7.5"
+jsoup = "1.15.3"


We can inline these once-use versions.

I think it's best to define all the versions at the top, because it's consistent, it's easier to scan the top to see the versions, and if any versions do need to be re-used then then it's less work (personally I find editing libs.versions.toml a bit fiddly, so I try to avoid it).

We can easy to know which versions are reused after inlining unnecessary ones, but either way.

I think it should be consistent - either all versions are at the top, or all of the versions are inlined, otherwise it might eventually lead to chaos. At the moment, I personally don't have any preference, so I'm fine with either approach 👍

integration-tests/build.gradle.kts

kotlin-analysis/intellij-dependency/build.gradle.kts

plugins/base/base-test-utils/build.gradle.kts

IgnatBeresnev

Had a glance - looking good, thanks!

I'll have a closer look once #2704 gets merged and this PR is rebased onto it

gradle/libs.versions.toml

kotlin-analysis/intellij-dependency/build.gradle.kts

IgnatBeresnev · 2023-03-07T23:50:05Z

Since there are a bunch of conflicts, proposing to merge #2652 first, it's been waiting for a while :) Hopefully shouldn't take as long

aSemy · 2023-03-08T10:13:31Z

Since there are a bunch of conflicts, proposing to merge #2652 first, it's been waiting for a while :) Hopefully shouldn't take as long

Agreed, sounds good!

IgnatBeresnev · 2023-03-13T13:53:59Z

The PR is ready to be rebased :) Looking forward to it!

Please, if you can, try to address copy-pasted versions that I mentioned in #2912 (comment), I assumed that we'd have the actual version strings in the toml only

build-logic/src/main/kotlin/org/jetbrains/publication.kt

examples/gradle/dokka-customFormat-example/build.gradle.kts

aSemy · 2023-03-14T19:49:21Z

settings.gradle.kts

 rootProject.name = "dokka"

+pluginManagement {
+    includeBuild("build-logic")


I moved includeBuild into the plugins block as recommended

You may also use the includeBuild mechanism outside pluginManagement to include plugin builds. However, this does not support all use cases and including plugin builds like that might be deprecated in a future Gradle version.

I also moved the repository definitions to be above plugins block, since logically the repos should be defined before plugins are resolved - but that's not important and I can revert if you want.

I moved it out cause I noticed detekt/detekt#5690.

Hm. We don't use configuration cache in this project, do we? So we don't have the warning yet, but it might resurface one day

I don't mind leaving it as is, we can deal with the warning when we get it, but if you do move it out - please add a comment why

Make sense.

I don't think the warning in detekt/detekt#5690 is about configuration cache, it's about the (configuration of) build cache.

https://github.com/detekt/detekt/blob/b07acae2b5ce2d5c8e8216a4e3e022f89c5fa67f/settings.gradle.kts#L71-L84

But Dokka doesn't have that (JetBrains really should set up a Gradle Build Cache server though!)

JetBrains really should set up a Gradle Build Cache server though!

JFYI we actually have a JetBrains instance for Gradle Enterprise (ge.jetbrains.com), but it didn't look like it using it would benefit us in any way compared to what we have now. If there's some really cool things that can be done with it that will work with Dokka, we can switch to it, no problem

If there's public, read-only access to the JetBrains Gradle build cache server then that would definitely help! It means that everyone's builds would be faster.

https://docs.gradle.org/current/userguide/build_cache.html#sec:build_cache_configure_remote

Goooler

Good to see this, both version catalog and type-safe project accessors!
We can rename this PR's title to something like "Migrate to type-safe dependency accessors"?

Goooler · 2023-03-15T01:47:36Z

gradle/libs.versions.toml

+kotlin-plugin = "213-1.8.10-release-430-IJ6777.52"
+kotlinx-coroutines = "1.6.3"
+kotlinx-html = "0.7.5"
+jsoup = "1.15.3"


We can easy to know which versions are reused after inlining unnecessary ones, but either way.

IgnatBeresnev

Great to see, as always!

The main integration tests are failing, could you please fix it? I'll run longer integration tests after that

runners/gradle-plugin/build.gradle.kts

kotlin-analysis/intellij-dependency/build.gradle.kts

core/content-matcher-test-utils/build.gradle.kts

…ode will probably be refactored later in Kotlin#2889)

# Conflicts: # gradle.properties # runners/maven-plugin/build.gradle.kts

- re-use Maven versions from version-catalog - update naming to be more consistent

aSemy · 2023-03-16T12:02:56Z

runners/gradle-plugin/build.gradle.kts

-
-    compileOnly("org.jetbrains.kotlin:kotlin-gradle-plugin")
-    compileOnly("com.android.tools.build:gradle:4.0.1")
-    compileOnly(gradleKotlinDsl())


I removed compileOnly(gradleKotlinDsl()) because it's added by the kotlin-dsl plugin

integration-tests/gradle/projects/serialization/kotlinx-serialization

IgnatBeresnev · 2023-03-16T14:05:49Z

Triggered teamcity integration tests, can be merged once they pass

upd: some failed :(

gradle/libs.versions.toml

helps with compatibility with older Kotlin versions, probably not needed once support for Kotlin 1.4 is dropped Co-authored-by: Ignat Beresnev <ignat@beresnev.me>

IgnatBeresnev · 2023-03-17T14:25:49Z

Looks like all the tests passed, merging it now 🎉

Thank you for this huge amount of work!

aSemy marked this pull request as ready for review February 22, 2023 10:08

Goooler reviewed Feb 22, 2023

View reviewed changes

IgnatBeresnev self-requested a review February 22, 2023 18:52

IgnatBeresnev added the infrastructure Everything related to builds tools, CI configurations and project tooling label Feb 22, 2023

IgnatBeresnev mentioned this pull request Feb 23, 2023

Improve compatibility with the Gradle API, and follow best practices #2700

Open

IgnatBeresnev reviewed Feb 23, 2023

View reviewed changes

gradle/libs.versions.toml Outdated Show resolved Hide resolved

kotlin-analysis/intellij-dependency/build.gradle.kts Outdated Show resolved Hide resolved

IgnatBeresnev self-requested a review February 23, 2023 04:49

aSemy marked this pull request as draft February 23, 2023 08:39

aSemy mentioned this pull request Feb 23, 2023

Remove dependabot configuration #2886

Merged

aSemy mentioned this pull request Mar 9, 2023

Refactor Maven Runner build config #2911

Merged

aSemy added 2 commits March 14, 2023 19:27

remove implementation(kotlin("stdlib"))` dependency

df50360

set up Version Catalog and typesafe project accessors

4f49425

aSemy force-pushed the feat/gradle_version_catalog branch from d59d0eb to 4f49425 Compare March 14, 2023 18:36

aSemy added 3 commits March 14, 2023 20:34

tidy up libs.versions.toml

1ebac4b

tidy up versioning example

bf3af3a

remove versions from gradle.properties

6ba58c6

aSemy commented Mar 14, 2023

View reviewed changes

aSemy marked this pull request as ready for review March 14, 2023 19:53

aSemy requested review from Goooler and IgnatBeresnev and removed request for IgnatBeresnev and Goooler March 14, 2023 19:58

Goooler reviewed Mar 15, 2023

View reviewed changes

IgnatBeresnev approved these changes Mar 15, 2023

View reviewed changes

runners/gradle-plugin/build.gradle.kts Outdated Show resolved Hide resolved

kotlin-analysis/intellij-dependency/build.gradle.kts Show resolved Hide resolved

aSemy changed the title ~~build config: define dependency versions in Gradle Version Catalog~~ build config: Gradle Version Catalog + type-safe project dependencies Mar 16, 2023

aSemy commented Mar 16, 2023

View reviewed changes

core/content-matcher-test-utils/build.gradle.kts Show resolved Hide resolved

suppress unstable Configuration.invoke() + dependency catalog (this c…

37937d4

…ode will probably be refactored later in Kotlin#2889)

aSemy added 3 commits March 16, 2023 12:46

Merge branch 'master' into feat/gradle_version_catalog

c937650

# Conflicts: # gradle.properties # runners/maven-plugin/build.gradle.kts

refactor maven-cli-setup.gradle.kts

865ceb1

- re-use Maven versions from version-catalog - update naming to be more consistent

fix api/implementation dependency on :core in gradle plugin

b087a7d

aSemy commented Mar 16, 2023

View reviewed changes

integration-tests/gradle/projects/serialization/kotlinx-serialization Outdated Show resolved Hide resolved

revert kxs submodule version

f4c3b29

IgnatBeresnev reviewed Mar 16, 2023

View reviewed changes

gradle/libs.versions.toml Outdated Show resolved Hide resolved

IgnatBeresnev reviewed Mar 16, 2023

View reviewed changes

gradle/libs.versions.toml Outdated Show resolved Hide resolved

IgnatBeresnev mentioned this pull request Mar 16, 2023

Integration tests refactoring #2925

Open

aSemy and others added 3 commits March 16, 2023 17:31

add -jvm suffix to dependencies

0e2f177

helps with compatibility with older Kotlin versions, probably not needed once support for Kotlin 1.4 is dropped Co-authored-by: Ignat Beresnev <ignat@beresnev.me>

move kotlinx-cli version to a separate version

5717321

Merge branch 'master' into feat/gradle_version_catalog

d216e45

IgnatBeresnev merged commit 8bb4f4a into Kotlin:master Mar 17, 2023
29 checks passed

aSemy deleted the feat/gradle_version_catalog branch April 17, 2023 13:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build config: Gradle Version Catalog + type-safe project dependencies #2884

build config: Gradle Version Catalog + type-safe project dependencies #2884

aSemy commented Feb 22, 2023 •

edited

Goooler left a comment

Goooler Feb 22, 2023

aSemy Mar 14, 2023

Goooler Mar 15, 2023 •

edited

IgnatBeresnev Mar 16, 2023

IgnatBeresnev left a comment

IgnatBeresnev commented Mar 7, 2023

aSemy commented Mar 8, 2023

IgnatBeresnev commented Mar 13, 2023

aSemy Mar 14, 2023

Goooler Mar 15, 2023 •

edited

IgnatBeresnev Mar 15, 2023

Goooler Mar 16, 2023

aSemy Mar 16, 2023

IgnatBeresnev Mar 16, 2023

aSemy Mar 16, 2023

Goooler left a comment

Goooler Mar 15, 2023 •

edited

IgnatBeresnev left a comment

aSemy Mar 16, 2023

IgnatBeresnev commented Mar 16, 2023 •

edited

IgnatBeresnev commented Mar 17, 2023

build config: Gradle Version Catalog + type-safe project dependencies #2884

build config: Gradle Version Catalog + type-safe project dependencies #2884

Conversation

aSemy commented Feb 22, 2023 • edited

Goooler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Goooler Mar 15, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IgnatBeresnev left a comment

Choose a reason for hiding this comment

IgnatBeresnev commented Mar 7, 2023

aSemy commented Mar 8, 2023

IgnatBeresnev commented Mar 13, 2023

Choose a reason for hiding this comment

Goooler Mar 15, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Goooler left a comment

Choose a reason for hiding this comment

Goooler Mar 15, 2023 • edited

Choose a reason for hiding this comment

IgnatBeresnev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

IgnatBeresnev commented Mar 16, 2023 • edited

IgnatBeresnev commented Mar 17, 2023

aSemy commented Feb 22, 2023 •

edited

Goooler Mar 15, 2023 •

edited

Goooler Mar 15, 2023 •

edited

Goooler Mar 15, 2023 •

edited

IgnatBeresnev commented Mar 16, 2023 •

edited