Update to Gradle 9.3.1 and enable the configuration cache by wmdietl · Pull Request #1362 · eisop/checker-framework

wmdietl · 2025-08-05T14:15:15Z

There is an issue with the CF Gradle plugin, which causes e.g. the failure in docs/examples/errorprone:

> Task :createCheckerFrameworkManifest
> Task :compileJava FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileJava'.
> Cannot mutate the dependencies of configuration ':checkerFramework' after the configuration was resolved. After a configuration has been observed, it should not be modified.

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to generate a Build Scan (Powered by Develocity).
> Get more help at https://help.gradle.org.

BUILD FAILED in 656ms
2 actionable tasks: 2 executed

I don't know whether there is a change in the configuration that could fix this or whether the plugin itself needs to be updated.

…the cache

Copilot

Pull request overview

This PR updates the Gradle wrapper from version 8.14.4 to 9.3.1 (not 9.0.0 as stated in the title) and enables the Gradle configuration cache feature. The changes refactor various build tasks to be compatible with configuration cache requirements by separating configuration-time work from execution-time work.

Changes:

Updated Gradle wrapper files to version 9.3.1
Enabled configuration cache in gradle.properties
Refactored build tasks to move file operations and logic from configuration phase to execution phase for configuration cache compatibility
Created separate Copy tasks to replace doLast blocks in shadowJar and other tasks
Updated manifest configuration and spotless plugin usage for Gradle 9 compatibility

Reviewed changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
gradlew	Updated Gradle wrapper script (contains copyright year regression)
gradle/wrapper/gradle-wrapper.properties	Updated Gradle distribution to 9.3.1
gradle/wrapper/gradle-wrapper.jar	Updated Gradle wrapper JAR binary for version 9.3.1
gradle.properties	Enabled configuration cache feature
gradle-mvn-push.gradle	Commented out shadowRuntimeElements workaround that no longer works
framework/build.gradle	Refactored copyAndMinimizeAnnotatedJdkFiles into separate tasks (has configuration cache issues)
docs/examples/*/gradle.properties	Added gradle.properties files to examples (invalid syntax - just contain path references)
docs/build.gradle	Captured file reference early for configuration cache compatibility
checker/build.gradle	Refactored assembleForJavac and related tasks into separate Copy tasks; moved cleanup logic; updated publishing syntax
checker-qual/build.gradle	Added bnd plugin workaround for configuration cache
checker-qual-android/build.gradle	Moved delete operation to separate task (still has configuration cache issues)
build.gradle	Refactored setLocalRepo to use output files; updated spotless; captured project properties early; refactored manifest configuration (has bugs in archiveFileName.map usage)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-24T21:42:56Z

 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip


The PR title mentions "Update to Gradle 9.0.0" but the actual version being updated to is 9.3.1 as shown in the gradle-wrapper.properties file. The title should be updated to reflect the correct version.

Copilot · 2026-02-24T21:42:57Z

@@ -0,0 +1 @@
+../../../gradle.properties


This file contains only a relative path ../../../gradle.properties which is not valid gradle.properties syntax. The intention appears to be to reference or include the root gradle.properties file, but gradle.properties files don't support includes or references. Either the actual property values should be duplicated here, or this file should be replaced with a symbolic link, or a different mechanism should be used to share properties across example projects.

Copilot · 2026-02-24T21:42:57Z

@@ -0,0 +1 @@
+../../../gradle.properties


This file contains only a relative path ../../../gradle.properties which is not valid gradle.properties syntax. The intention appears to be to reference or include the root gradle.properties file, but gradle.properties files don't support includes or references. Either the actual property values should be duplicated here, or this file should be replaced with a symbolic link, or a different mechanism should be used to share properties across example projects.

This is a symbolic link, not a file that contains this path.

Copilot · 2026-02-24T21:42:57Z

@@ -0,0 +1 @@
+../../../gradle.properties


This file contains only a relative path ../../../gradle.properties which is not valid gradle.properties syntax. The intention appears to be to reference or include the root gradle.properties file, but gradle.properties files don't support includes or references. Either the actual property values should be duplicated here, or this file should be replaced with a symbolic link, or a different mechanism should be used to share properties across example projects.

Copilot · 2026-02-24T21:42:57Z

+}
+
+tasks.register('copyCheckerQualJar', Copy) {
+    dependsOn ':checker-qual:jar'


The copyCheckerQualJar task has duplicate dependsOn declarations (lines 144-145). Both dependsOn ':checker-qual:jar' and dependsOn project(':checker-qual').tasks.jar refer to the same task. One of these should be removed to avoid redundancy.

Suggested change

dependsOn ':checker-qual:jar'

Copilot · 2026-02-24T21:42:58Z

+    FileTree tree = fileTree(dir: inputDir)
+    String absolutejdkHome = file(annotatedJdkHome).absolutePath
+    int jdkDirStringSize = absolutejdkHome.size()
+
+    NavigableSet<String> annotatedForFiles = new TreeSet<>();
+    // Populate `annotatedForFiles`.
+    tree.visit { FileVisitDetails fvd ->
+        if (!fvd.file.isDirectory() && fvd.file.name.matches('.*\\.java')
+                && !fvd.file.path.contains('org/checkerframework')) {
+            fvd.getFile().readLines().any { line ->
+                if (line.contains('@AnnotatedFor') || line.contains('org.checkerframework') || line.contains('org.jspecify')) {
+                    annotatedForFiles.add(fvd.file.absolutePath)
+                    return true;
+                }
+            }
+        }
+    }
+
+    from(annotatedJdkHome)
+    into(outputDir)
+    for (String filename : annotatedForFiles) {
+        include filename.substring(jdkDirStringSize)


The copyAnnotatedJdkFiles task has configuration cache compatibility issues. The task is reading files and populating the annotatedForFiles set during the configuration phase (lines 109-125), which violates configuration cache principles. This work should be moved to the execution phase using a doFirst or doLast block. Additionally, the file tree traversal and file reading should be done at execution time to avoid capturing file system state during configuration.

Suggested change

FileTree tree = fileTree(dir: inputDir)

String absolutejdkHome = file(annotatedJdkHome).absolutePath

int jdkDirStringSize = absolutejdkHome.size()

NavigableSet<String> annotatedForFiles = new TreeSet<>();

// Populate `annotatedForFiles`.

tree.visit { FileVisitDetails fvd ->

if (!fvd.file.isDirectory() && fvd.file.name.matches('.*\\.java')

&& !fvd.file.path.contains('org/checkerframework')) {

fvd.getFile().readLines().any { line ->

if (line.contains('@AnnotatedFor') || line.contains('org.checkerframework') || line.contains('org.jspecify')) {

annotatedForFiles.add(fvd.file.absolutePath)

return true;

}

}

}

}

from(annotatedJdkHome)

into(outputDir)

for (String filename : annotatedForFiles) {

include filename.substring(jdkDirStringSize)

from(annotatedJdkHome)

into(outputDir)

doFirst {

String absolutejdkHome = file(annotatedJdkHome).absolutePath

int jdkDirStringSize = absolutejdkHome.size()

NavigableSet<String> annotatedForFiles = new TreeSet<>()

FileTree tree = fileTree(dir: inputDir)

// Populate `annotatedForFiles`.

tree.visit { FileVisitDetails fvd ->

if (!fvd.file.isDirectory() && fvd.file.name.matches('.*\\.java')

&& !fvd.file.path.contains('org/checkerframework')) {

fvd.getFile().readLines().any { line ->

if (line.contains('@AnnotatedFor') || line.contains('org.checkerframework') || line.contains('org.jspecify')) {

annotatedForFiles.add(fvd.file.absolutePath)

return true

}

}

}

}

for (String filename : annotatedForFiles) {

include filename.substring(jdkDirStringSize)

}

Copilot · 2026-02-24T21:42:58Z

@@ -0,0 +1 @@
+../../../gradle.properties


This file contains only a relative path ../../../gradle.properties which is not valid gradle.properties syntax. The intention appears to be to reference or include the root gradle.properties file, but gradle.properties files don't support includes or references. Either the actual property values should be duplicated here, or this file should be replaced with a symbolic link, or a different mechanism should be used to share properties across example projects.

Copilot · 2026-02-24T21:42:58Z


 #
-# Copyright © 2015-2021 the original authors.
+# Copyright © 2015 the original authors.


The copyright year range has been changed from "2015-2021" to just "2015". This appears to be a regression that removes the end year of the copyright range. The Gradle wrapper update should preserve the full copyright notice, or update it to include the current year if that was the intention.

Suggested change

# Copyright © 2015 the original authors.

# Copyright © 2015-2021 the original authors.

Copilot · 2026-02-24T21:42:58Z

+tasks.register('deletePreviousSources') {
+    // Delete the directory in case a previously copied file should no longer be in checker-qual.
+    delete file(layout.buildDirectory.dir("generated/sources/main/java"))


The deletePreviousSources task performs a delete operation during the configuration phase (line 5), which violates configuration cache principles. The delete operation should be moved to the execution phase by wrapping it in a doFirst or doLast block, or by making this a Delete task type instead of a generic task.

Suggested change

tasks.register('deletePreviousSources') {

// Delete the directory in case a previously copied file should no longer be in checker-qual.

delete file(layout.buildDirectory.dir("generated/sources/main/java"))

tasks.register('deletePreviousSources', Delete) {

// Delete the directory in case a previously copied file should no longer be in checker-qual.

delete layout.buildDirectory.dir("generated/sources/main/java")

wmdietl added 2 commits August 4, 2025 21:42

Update to gradle 9.0.0

94d0fa6

Enable Gradle configuration cache and fix issues

a270387

wmdietl mentioned this pull request Aug 5, 2025

Update dependency gradle to v9 #1360

Closed

1 task

Merge branch 'master' into gradle-9.0.0

3a568a8

wmdietl mentioned this pull request Aug 21, 2025

Bump com.gradleup.shadow from 8.3.8 to 9.0.2 #1372

Closed

wmdietl mentioned this pull request Sep 12, 2025

Update Gradle to v9 #1389

Closed

1 task

wmdietl added 9 commits September 16, 2025 20:51

Merge branch 'master' into gradle-9.0.0

a1d888c

Split up copying the annotated JDK and minimizing it

8e8dc4e

Disable a broken work-around

03d391b

Split out separate copy tasks

b41fe9a

Work around a bnd issue

ab7683f

Split out deleting previous sources

0bc6604

Work arounds to make the Gradle configuration cache happy

b29932f

Use the same gradle.properties for subprojects, especially to enable …

426e48a

…the cache

Merge branch 'master' into gradle-9.0.0

716d3d4

Copilot AI review requested due to automatic review settings February 24, 2026 21:37

wmdietl changed the title ~~Update to Gradle 9.0.0 and enable the configuration cache~~ Update to Gradle 9.3.1 and enable the configuration cache Feb 24, 2026

Copilot started reviewing on behalf of wmdietl February 24, 2026 21:38 View session

Copilot AI reviewed Feb 24, 2026

View reviewed changes

This was referenced Mar 6, 2026

Bump gradle-wrapper from 8.14.4 to 9.3.0 #1513

Closed

Bump gradle-wrapper from 8.14.4 to 9.4.0 #1571

Closed

wmdietl mentioned this pull request Mar 20, 2026

Bump gradle-wrapper from 8.14.4 to 9.4.1 #1599

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to Gradle 9.3.1 and enable the configuration cache#1362

Update to Gradle 9.3.1 and enable the configuration cache#1362
wmdietl wants to merge 12 commits intomasterfrom
gradle-9.0.0

wmdietl commented Aug 5, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

wmdietl Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Copilot AI Feb 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -0,0 +1 @@
		../../../gradle.properties No newline at end of file

	# Copyright © 2015 the original authors.
	# Copyright © 2015-2021 the original authors.

Conversation

wmdietl commented Aug 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

wmdietl Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants