Skip to content

Use version catalog. #7381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+127 −61
Open

Use version catalog. #7381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96078d8
Use version catalog.
smillst Nov 14, 2025
ed94dd7
Change comment.
smillst Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions annotation-file-utilities/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ dependencies {
// Annotations in checker-qual.jar are used, but no checkers are (currently) run on the code.
compileOnly(project(":checker-qual"))

implementation("org.plumelib:options:2.0.3")
implementation("org.plumelib:plume-util:${plumeUtilVersion}")
implementation("org.plumelib:reflection-util:${reflectionUtilVersion}")
implementation("org.checkerframework.annotatedlib:guava:33.1.0.2-jre") {
implementation(libs.options)
implementation(libs.plume.util)
implementation(libs.reflection.util)
implementation(libs.guava) {
// So long as Guava only uses annotations from checker-qual, excluding it should not cause problems.
exclude group: "org.checkerframework"
}
implementation("org.ow2.asm:asm:9.9")
testImplementation("junit:junit:${junitVersion}")
implementation(libs.asm)
testImplementation(libs.junit)
testImplementation(project(":checker-qual"))
}

Expand Down
19 changes: 10 additions & 9 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
plugins {
// https://plugins.gradle.org/plugin/com.gradleup.shadow
id("com.gradleup.shadow").version("9.2.2")
alias(libs.plugins.com.gradleup.shadow)
// https://plugins.gradle.org/plugin/de.undercouch.download
id("de.undercouch.download").version("5.6.0")
alias(libs.plugins.de.undercouch.download)
id("java")
// https://github.com/tbroyer/gradle-errorprone-plugin
id("net.ltgt.errorprone").version("4.3.0")
alias(libs.plugins.net.ltgt.errorprone)
// https://docs.gradle.org/current/userguide/eclipse_plugin.html
id("eclipse")

id("groovy") // needed for formatting Gradle files

// Code formatting; defines targets "spotlessApply" and "spotlessCheck".
// https://github.com/diffplug/spotless/tags ; see tags starting "gradle/"
// Only works on JDK 11+ (even including the plugin crashes Gradle on JDK 8);
// shell scripts in checker/bin-devel/ ensure spotless isn't called unless
// the JDK is 17 or later.
id("com.diffplug.spotless").version("8.0.0")
alias(libs.plugins.com.diffplug.spotless)
}
apply from: rootProject.file("release.gradle")

Expand Down Expand Up @@ -207,7 +208,7 @@ allprojects { currentProj ->
}

dependencies {
errorprone("com.google.errorprone:error_prone_core:${errorproneVersion}")
errorprone(libs.error.prone.core)

javacJar("com.google.errorprone:javac:9+181-r4173-1")

Expand Down Expand Up @@ -575,7 +576,7 @@ allprojects { currentProj ->
"-Xep:NonOverridingEquals:OFF",
// Suggests using a class that's in Error Prone itself, not in any library for clients.
// It requires "import com.google.errorprone.util.ASTHelpers;", and (in build.gradle)
// implementation("com.google.errorprone:error_prone_core:${errorproneVersion}")
// implementation(libs.error.prone.core)
// Adding that line in build.gradle causes a javac crash when running the Checker Framework.
"-Xep:ASTHelpersSuggestions:OFF",
// Removing "public" from private class members loses information about the abstraction.
Expand Down Expand Up @@ -825,7 +826,7 @@ configurations {
requireJavadoc
}
dependencies {
requireJavadoc("org.plumelib:require-javadoc:2.0.0")
requireJavadoc(libs.require.javadoc)
}
tasks.register("requireJavadoc", JavaExec) {
description = "Ensures that Javadoc documentation exists in source code."
Expand Down Expand Up @@ -957,8 +958,8 @@ subprojects {

dependencies {
// TODO: it's a bug that annotatedlib:guava requires the error_prone_annotations dependency.
annotatedGuava("com.google.errorprone:error_prone_annotations:${errorproneVersion}")
annotatedGuava("org.checkerframework.annotatedlib:guava:33.1.0.2-jre") {
annotatedGuava(libs.error.prone.annotations)
annotatedGuava(libs.guava) {
// So long as Guava only uses annotations from checker-qual, excluding it should not cause problems.
exclude group: "org.checkerframework"
}
Expand Down
2 changes: 1 addition & 1 deletion checker-qual/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
plugins {
id("java-library")
id("biz.aQute.bnd.builder").version("7.1.0")
alias(libs.plugins.biz.aqute.bnd.builder)
}

sourceSets {
Expand Down
2 changes: 1 addition & 1 deletion checker-util/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ dependencies {
api(project(":checker-qual"))
// Don't add implementation dependencies; checker-util.jar should have no dependencies.

testImplementation("junit:junit:${junitVersion}")
testImplementation(libs.junit)
}

jar {
Expand Down
28 changes: 14 additions & 14 deletions checker/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ plugins {
id("base")
// https://github.com/n0mer/gradle-git-properties
// Generates file build/resources/main/git.properties when the `classes` task runs.
id("com.gorylenko.gradle-git-properties").version("2.5.3")
alias(libs.plugins.com.gorylenko.gradle.git.properties)
}

sourceSets {
Expand Down Expand Up @@ -42,33 +42,33 @@ dependencies {
// If you add an external dependency, you must shadow its packages.
// See the comment in ../build.gradle in the shadowJar block.

implementation("org.plumelib:reflection-util:${reflectionUtilVersion}")
implementation("org.plumelib:plume-util:${plumeUtilVersion}")
implementation(libs.reflection.util)
implementation(libs.plume.util)

// Dependencies added to "shadow" appear as dependencies in Maven Central.
shadow(project(":checker-qual"))
shadow(project(":checker-util"))

// Called Methods Checker AutoValue + Lombok support
testImplementation("com.google.auto.value:auto-value-annotations:${autoValueVersion}")
testImplementation("com.google.auto.value:auto-value:${autoValueVersion}")
testImplementation("com.ryanharter.auto.value:auto-value-parcel:0.2.9")
testImplementation("org.projectlombok:lombok:${lombokVersion}")
testImplementation(libs.auto.value.annotations)
testImplementation(libs.auto.value)
testImplementation(libs.auto.value.parcel)
testImplementation(libs.lombok)

// Called Methods Checker support for detecting misuses of AWS APIs
testImplementation("com.amazonaws:aws-java-sdk-ec2")
testImplementation("com.amazonaws:aws-java-sdk-kms")
testImplementation(libs.aws.java.sdk.ec2)
testImplementation(libs.aws.java.sdk.kms)
// The AWS SDK is used for testing the Called Methods Checker.
testImplementation(platform("com.amazonaws:aws-java-sdk-bom:1.12.793"))
testImplementation(platform(libs.aws.java.sdk.bom))
// For the Resource Leak Checker's support for JavaEE.
testImplementation("javax.servlet:javax.servlet-api:4.0.1")
testImplementation(libs.javax.servlet.api)
// For the Resource Leak Checker's support for IOUtils.
testImplementation("commons-io:commons-io:2.21.0")
testImplementation(libs.commons.io)
// To test for an obscure crash in CFG construction for try-with-resources;
// see https://github.com/typetools/checker-framework/issues/6396
testImplementation("org.apache.spark:spark-sql_2.12:3.3.2")
testImplementation(libs.spark.sql)

testImplementation("junit:junit:${junitVersion}")
testImplementation(libs.junit)
testImplementation(project(":framework-test"))
testImplementation(sourceSets.testannotations.output)

Expand Down
6 changes: 3 additions & 3 deletions dataflow/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ dependencies {
api(project(":checker-qual"))

// Node implements org.plumelib.util.UniqueId, so this dependency must be "api".
api("org.plumelib:plume-util:${plumeUtilVersion}")
api(libs.plume.util)

implementation("org.plumelib:hashmap-util:${hashmapUtilVersion}")
implementation(libs.hashmap.util)

testImplementation("junit:junit:${junitVersion}")
testImplementation(libs.junit)

// External dependencies:
// If you add an external dependency, you must shadow its packages both in the dataflow-shaded
Expand Down
4 changes: 2 additions & 2 deletions framework-test/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ sourceSets {
}

dependencies {
implementation("junit:junit:${junitVersion}")
implementation(libs.junit)
implementation(project(":javacutil"))
implementation(project(":checker-qual"))

implementation("org.plumelib:plume-util:${plumeUtilVersion}")
implementation(libs.plume.util)
testImplementation(project(":framework"))
}

Expand Down
20 changes: 10 additions & 10 deletions framework/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ def stubifierJar = tasks.register("stubifierJar", Jar) {
dependencies {
api(project(":javacutil"))
api(project(":dataflow"))
api("org.checkerframework:stubparser:3.27.1")
stubifierImplementation("org.checkerframework:stubparser:3.26.4")
api(libs.stubparser)
stubifierImplementation(libs.stubparser)
// This should be implementation sourceSets.stubifier.output, but that cause a failure in shadowJar.
// This work around is from here: https://github.com/GradleUp/shadow/issues/1606#issuecomment-3164731141
implementation(files(stubifierJar))
Expand All @@ -49,21 +49,21 @@ dependencies {
// External dependencies:
// If you add an external dependency, you must shadow its packages.
// See the comment in ../build.gradle in the shadowJar block.
implementation("org.plumelib:hashmap-util:${hashmapUtilVersion}")
implementation("org.plumelib:plume-util:${plumeUtilVersion}")
implementation("org.plumelib:reflection-util:${reflectionUtilVersion}")
implementation("io.github.classgraph:classgraph:4.8.184")
implementation(libs.hashmap.util)
implementation(libs.plume.util)
implementation(libs.reflection.util)
implementation(libs.classgraph)

testImplementation("junit:junit:${junitVersion}")
testImplementation(libs.junit)
testImplementation(project(":framework-test"))
testImplementation(sourceSets.testannotations.output)

// AutoValue support in Returns Receiver Checker
testImplementation("com.google.auto.value:auto-value-annotations:${autoValueVersion}")
testImplementation("com.google.auto.value:auto-value:${autoValueVersion}")
testImplementation(libs.auto.value.annotations)
testImplementation(libs.auto.value)

// Lombok support in Returns Receiver Checker
testImplementation("org.projectlombok:lombok:${lombokVersion}")
testImplementation(libs.lombok)
}

tasks.register("cloneTypetoolsJdk", CloneTask) {
Expand Down
12 changes: 0 additions & 12 deletions gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,4 @@ org.gradle.parallel=true
org.gradle.jvmargs=-Xmx4g -Dfile.encoding=UTF-8
org.gradle.caching=true

# If you update errorproneVersion:
# * Temporarily comment out "-Werror" in build.gradle files.
# * Repeatedly run `./gradlew clean compileJava` and fix all errors.
# * Uncomment "-Werror".

autoValueVersion=1.11.1
errorproneVersion=2.44.0
googleJavaFormatVersion=1.30.0
Copy link
Member Author

@smillst smillst Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move back to main build file.

hashmapUtilVersion=0.0.1
junitVersion=4.13.2
lombokVersion=1.18.42
plumeUtilVersion=1.12.2
reflectionUtilVersion=1.1.5
77 changes: 77 additions & 0 deletions gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
## Generated by adding the following to setting.gradle
Copy link
Member Author

@smillst smillst Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this comment

## plugins {
## // See https://jmfayard.github.io/refreshVersions
## id("de.fayard.refreshVersions") version "0.60.6"
## }
## and then running:
## ./gradlew refreshVersionsMigrate --mode=VersionCatalogOnly

[plugins]

com-gradleup-shadow = { id = "com.gradleup.shadow", version = "9.2.2" }

de-undercouch-download = { id = "de.undercouch.download", version = "5.6.0" }

net-ltgt-errorprone = { id = "net.ltgt.errorprone", version = "4.3.0" }

com-diffplug-spotless = { id = "com.diffplug.spotless", version = "8.0.0" }

com-gorylenko-gradle-git-properties = { id = "com.gorylenko.gradle-git-properties", version = "2.5.3" }

biz-aqute-bnd-builder = { id = "biz.aQute.bnd.builder", version = "7.1.0" }

[versions]

junit-junit = "4.13.2"

[libraries]

# If you update errorproneVersion:
# * Temporarily comment out "-Werror" in build.gradle files.
# * Repeatedly run `./gradlew clean compileJava` and fix all errors.
# * Uncomment "-Werror".
error-prone-core = "com.google.errorprone:error_prone_core:2.44.0"

javac = "com.google.errorprone:javac:9+181-r4173-1"

require-javadoc = "org.plumelib:require-javadoc:2.0.0"

error-prone-annotations = "com.google.errorprone:error_prone_annotations:2.44.0"

guava = "org.checkerframework.annotatedlib:guava:33.1.0.2-jre"

options = "org.plumelib:options:2.0.3"

plume-util = "org.plumelib:plume-util:1.12.2"

reflection-util = "org.plumelib:reflection-util:1.1.5"

asm = "org.ow2.asm:asm:9.9"

junit = { group = "junit", name = "junit", version.ref = "junit-junit" }

auto-value-annotations = "com.google.auto.value:auto-value-annotations:1.11.1"

auto-value = "com.google.auto.value:auto-value:1.11.1"

auto-value-parcel = "com.ryanharter.auto.value:auto-value-parcel:0.2.9"

lombok = "org.projectlombok:lombok:1.18.42"

aws-java-sdk-ec2 = { module = "com.amazonaws:aws-java-sdk-ec2" }

aws-java-sdk-kms = { module = "com.amazonaws:aws-java-sdk-kms" }

aws-java-sdk-bom = "com.amazonaws:aws-java-sdk-bom:1.12.793"

javax-servlet-api = "javax.servlet:javax.servlet-api:4.0.1"

commons-io = "commons-io:commons-io:2.21.0"

spark-sql = "org.apache.spark:spark-sql_2.12:3.3.2"

hashmap-util = "org.plumelib:hashmap-util:0.0.1"

stubparser = "org.checkerframework:stubparser:3.27.1"

classgraph = "io.github.classgraph:classgraph:4.8.184"
Comment on lines +1 to +77
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

Version catalog appears comprehensive but missing google-java-format library.

The catalog defines 6 plugins and 20+ libraries for the migration. However, build.gradle (lines 126, 353, 356) references googleJavaFormatVersion which is not defined in this catalog.

This library should either:

  1. Be added to the [libraries] section (if version catalog migration is intended to be complete), or
  2. Remain in gradle.properties (if intentionally excluded from the catalog)

Additionally, some entries (com-gorylenko-gradle-git-properties, aws-*, spark-sql) appear unused in the provided files, suggesting the automatic migration captured the complete inventory. Verify whether google-java-format should have been migrated as well.

🌐 Web query:

What is the latest version of google-java-format as of November 2025?

💡 Result:

The latest google-java-format release as of November 14, 2025 is v1.32.0 (released Oct 28, 2025). [1][2]

Sources:
[1] GitHub Releases — google/google-java-format (v1.32.0).
[2] google-java-format repository README.

🏁 Script executed:

#!/bin/bash
# Verify google-java-format references in build.gradle
echo "=== Searching for googleJavaFormat references ==="
rg -n "googleJavaFormat" --type gradle -A2 -B2

echo ""
echo "=== Checking if google-java-format is in the version catalog ==="
grep -i "google-java-format\|googleJavaFormat" gradle/libs.versions.toml || echo "NOT FOUND in catalog"

echo ""
echo "=== Counting entries in [libraries] section ==="
grep -A500 "^\[libraries\]" gradle/libs.versions.toml | grep "=" | wc -l

Length of output: 955


---

🏁 Script executed:

```shell
#!/bin/bash
# Find where googleJavaFormatVersion is defined
echo "=== Searching for googleJavaFormatVersion definition ==="
rg -n "googleJavaFormatVersion\s*=" --type gradle --type text -B1 -A1

echo ""
echo "=== Checking gradle.properties for version definitions ==="
if [ -f gradle.properties ]; then
  echo "gradle.properties found:"
  grep -n "Version\|version" gradle.properties | head -20
else
  echo "gradle.properties not found at root"
fi

echo ""
echo "=== Checking if plugins section references spotless ==="
grep -i "spotless" gradle/libs.versions.toml

Length of output: 336

Add missing google-java-format library to the version catalog.

The library is actively used in build.gradle (lines 126, 353, 356) via googleJavaFormatVersion, but is currently defined only in gradle.properties (line 8 with version 1.30.0) rather than in the version catalog.

To complete the migration, add the following entry to the [libraries] section of gradle/libs.versions.toml:

google-java-format = "com.google.googlejavaformat:google-java-format:1.30.0"

Consider also updating to the latest version (1.32.0, released October 2025) if desired.

🤖 Prompt for AI Agents 
In gradle/libs.versions.toml around lines 1-77, the version catalog is missing
the google-java-format library referenced from build.gradle; add a libraries
entry for google-java-format in the [libraries] section (use the current version
from gradle.properties, 1.30.0, or update to a newer version such as 1.32.0) so
build.gradle can reference googleJavaFormatVersion from the catalog.

6 changes: 3 additions & 3 deletions javacutil/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ dependencies {

// This is used by org.checkerframework.javacutil.TypesUtils.isImmutableTypeInJdk.
// https://mvnrepository.com/artifact/org.plumelib/plume-util
implementation("org.plumelib:hashmap-util:${hashmapUtilVersion}")
implementation("org.plumelib:plume-util:${plumeUtilVersion}")
implementation("org.plumelib:reflection-util:${reflectionUtilVersion}")
implementation(libs.hashmap.util)
implementation(libs.plume.util)
implementation(libs.reflection.util)

// External dependencies:
// If you add an external dependency, you must shadow its packages both in checker.jar and
Expand Down