Enable configuration caching #14725

koppor · 2025-12-26T13:08:54Z

User description

Now that jbangdev/jbang-gradle-plugin#7 is fixed in the respective main we can use configuration caching 🎉

Ports jbangdev/jbang-gradle-plugin#21 to here.

Steps to test

Execute ./gradlew --rerun-tasks :jablib:generateJournalListMV
Execute ./gradlew :jabgui:run.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
[/] I added screenshots in the PR description (if change is visible to the user)
[/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
[/] I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

PR Type

Enhancement

Description

Enable Gradle configuration caching for improved build performance
Replace custom download task with gradle-download-plugin
Update jbang-gradle-plugin to latest version
Reorder plugin application in module configuration

Diagram Walkthrough

flowchart LR
  A["Configuration Caching Disabled"] -->|Enable caching| B["Configuration Caching Enabled"]
  C["Custom Download Task"] -->|Use gradle-download-plugin| D["Gradle Download Plugin"]
  E["Old jbang Plugin"] -->|Update to latest| F["Latest jbang Plugin"]
  B --> G["Improved Build Performance"]
  D --> G

File Walkthrough

Relevant files

Dependencies

build.gradle.kts `Add gradle-download-plugin dependency` build-logic/build.gradle.kts Added gradle-download-plugin dependency version 5.6.0	+1/-0
build.gradle.kts `Add download plugin and update jbang plugin` jablib/build.gradle.kts Added org.jabref.gradle.feature.download plugin Updated jbang-gradle-plugin version to jitpack-SNAPSHOT Updated jbang plugin version comment from 0.2.0 to 0.3.0 Updated jitpack build reference URL	+9/-31

Configuration changes

org.jabref.gradle.feature.download.gradle.kts `Create download feature plugin configuration` build-logic/src/main/kotlin/org.jabref.gradle.feature.download.gradle.kts New plugin configuration file for download feature Applies de.undercouch.download plugin	+3/-0
org.jabref.gradle.module.gradle.kts `Reorder plugin application sequence` build-logic/src/main/kotlin/org.jabref.gradle.module.gradle.kts Reordered plugin application order Moved checkstyle and modernizer plugins before feature plugins	+2/-2

Enhancement

gradle.properties `Enable Gradle configuration caching` gradle.properties Enabled org.gradle.configuration-cache from false to true Enabled org.gradle.configuration-cache.parallel Removed blocking issue comment reference	+2/-3
build.gradle.kts `Replace custom download with gradle-download-plugin` jablib/build.gradle.kts Replaced custom downloadLtwaFile task with gradle-download-plugin implementation Changed from manual URI download to Download task type Added onlyIfModified flag for efficient caching Simplified task implementation from 30+ lines to 4 lines Changed ltwaCsvFile from var to val	+9/-31

qodo-free-for-open-source-projects · 2025-12-26T13:09:25Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
⚪	Unstable dependency version Description: Using a snapshot version from JitPack ('jitpack-SNAPSHOT') introduces supply chain risk as the dependency content can change without notice, potentially introducing malicious code or vulnerabilities. build.gradle.kts [24-24] Referred Code id("com.github.koppor.jbang-gradle-plugin") version "jitpack-SNAPSHOT"
	Unverified external download Description: Downloading files from external URLs without integrity verification (checksum/hash validation) allows potential man-in-the-middle attacks or compromised source servers to inject malicious content. build.gradle.kts [282-282] Referred Code src("https://www.issn.org/wp-content/uploads/2021/07/ltwa_20210702.csv") dest(ltwaCsvFile)
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2025-12-26T13:10:34Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	✅ ~~Avoid SNAPSHOT dependency for build stability~~ Suggestion Impact: The commit removed the jitpack-SNAPSHOT version specification from the jbang-gradle-plugin dependency. However, instead of replacing it with a stable version or commit hash as suggested, the version was removed entirely, leaving the plugin declaration without a version. This partially addresses the concern by removing the unstable SNAPSHOT dependency, though it doesn't follow the exact recommendation of specifying a stable version. code diff: - // Build state at https://jitpack.io/#koppor/jbang-gradle-plugin/jitpack-SNAPSHOT - id("com.github.koppor.jbang-gradle-plugin") version "jitpack-SNAPSHOT" + id("com.github.koppor.jbang-gradle-plugin") The PR introduces a `jitpack-SNAPSHOT` dependency for the `jbang-gradle-plugin`. To ensure build stability and reproducibility, this should be replaced with a stable, released version or pinned to a specific commit hash. Examples: jablib/build.gradle.kts [24] id("com.github.koppor.jbang-gradle-plugin") version "jitpack-SNAPSHOT" Solution Walkthrough: Before: // jablib/build.gradle.kts plugins { // ... // Build state at https://jitpack.io/#koppor/jbang-gradle-plugin/jitpack-SNAPSHOT id("com.github.koppor.jbang-gradle-plugin") version "jitpack-SNAPSHOT" // ... } After: // jablib/build.gradle.kts plugins { // ... // Use a stable release or a specific commit hash id("com.github.koppor.jbang-gradle-plugin") version "<stable-version-or-commit-hash>" // ... } Suggestion importance[1-10]: 9 __ Why: The suggestion correctly identifies a critical issue with using a `jitpack-SNAPSHOT` dependency, which makes the build non-reproducible and prone to breaking, and this change is a core part of the PR.	High
Learned best practice	Use val for immutable variables Change task variable declarations from 'var' to 'val' for consistency with the newly changed `ltwaCsvFile` variable. These task references are never reassigned and should be immutable. jablib/build.gradle.kts [255-287] -var taskGenerateJournalListMV = tasks.register<JBangTask>("generateJournalListMV") { +val taskGenerateJournalListMV = tasks.register<JBangTask>("generateJournalListMV") { ... -var taskGenerateCitationStyleCatalog = tasks.register<JBangTask>("generateCitationStyleCatalog") { +val taskGenerateCitationStyleCatalog = tasks.register<JBangTask>("generateCitationStyleCatalog") { ... -var taskGenerateLtwaListMV = tasks.register<JBangTask>("generateLtwaListMV") { +val taskGenerateLtwaListMV = tasks.register<JBangTask>("generateLtwaListMV") { `[To ensure code accuracy, apply this suggestion manually]` Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Use consistent variable declaration patterns. Prefer 'val' for immutable variables to improve code safety and clarity.	Low
General	Extract hardcoded version to constant Extract the hardcoded date `20210702` from the URL and filename into a constant to improve maintainability. jablib/build.gradle.kts [279-285] -val ltwaCsvFile = layout.buildDirectory.file("tmp/ltwa_20210702.csv") +val ltwaVersion = "20210702" +val ltwaCsvFile = layout.buildDirectory.file("tmp/ltwa_$ltwaVersion.csv") tasks.register<de.undercouch.gradle.tasks.download.Download>("downloadLtwaFile") { - src("https://www.issn.org/wp-content/uploads/2021/07/ltwa_20210702.csv") + src("https://www.issn.org/wp-content/uploads/2021/07/ltwa_$ltwaVersion.csv") dest(ltwaCsvFile) onlyIfModified(true) } Apply / Chat Suggestion importance[1-10]: 5 __ Why: The suggestion correctly identifies a repeated hardcoded value and proposes extracting it into a constant, which improves code maintainability by following the DRY principle.	Low
Update

Siedlerchr · 2025-12-26T14:14:02Z

Task :jablib:generateJournalListMV of type dev.jbang.gradle.tasks.JBangTask: cannot serialize Gradle script object references as these are not supported with the configuration cache.

Siedlerchr · 2025-12-26T14:21:41Z

In plugin 'com.github.koppor.jbang-gradle-plugin' type 'dev.jbang.gradle.tasks.JBangTask' property 'installDir' specifies directory '/home/runner/.gradle/caches/jbang' which doesn't exist.

Siedlerchr · 2025-12-26T16:18:48Z

You have overwritten my changes for creating the directory qodo-free-for-open-source-projects[bot] ***@***.***> schrieb am Fr., 26. Dez. 2025, 16:15:

…

*qodo-free-for-open-source-projects[bot]* left a comment (JabRef/jabref#14725) <#14725 (comment)> CI Feedback 🧐 (Feedback updated until commit f8c952a <f8c952a> ) A test triggered by this PR failed. Here is an AI-generated analysis of the failure: *Action:* Unit tests – jabsrv *Failed stage:* Run jabsrv tests <https://github.com/JabRef/jabref/actions/runs/20524633149/job/58965712894> [❌] *Failure summary:* The action failed due to a Gradle configuration cache problem. Specifically: - Task :jablib:generateJournalListMV of type dev.jbang.gradle.tasks.JBangTask cannot serialize Gradle script object references, which are not supported with the configuration cache. - The build completed successfully up to the test execution phase (14 tests passed), but failed during the configuration cache validation. - The error indicates that the task is trying to store unsupported object types in the configuration cache, violating Gradle's configuration cache requirements. Relevant error logs: 1: ##[group]Runner Image Provisioner2: Hosted Compute Agent ... 407: GRADLE_ACTION_ID: gradle/actions/setup-gradle408: GRADLE_USER_HOME: /home/runner/.gradle409: GRADLE_BUILD_ACTION_SETUP_COMPLETED: true410: GRADLE_BUILD_ACTION_CACHE_RESTORED: true411: DEVELOCITY_INJECTION_INIT_SCRIPT_NAME: gradle-actions.inject-develocity.init.gradle412: DEVELOCITY_INJECTION_CUSTOM_VALUE: gradle-actions413: GITHUB_DEPENDENCY_GRAPH_ENABLED: false414: CI: true415: ##[endgroup]416: Downloading https://files.jabref.org/gradle-9.3.0-jabref-2-bin.zip417: .............10%.............20%.............30%.............40%.............50%.............60%.............70%.............80%.............90%.............100%418: Starting a Gradle Daemon (subsequent builds will be faster)419: Parallel Configuration Cache is an incubating feature.420: Configuration on demand is an incubating feature.421: Calculating task graph as no cached configuration is available for tasks: :jabsrv:check422: > Task :build-logic:checkKotlinGradlePluginConfigurationErrors SKIPPED423: > Task :build-logic:generateExternalPluginSpecBuilders... 927: 2025-12-26 15:14:35 [main] org.gradle.internal.remote.internal.inet.TcpOutgoingConnector.connect()928: DEBUG: Connected to address /127.0.0.1:34987.929: 2025-12-26 15:14:35 [main] org.gradle.process.internal.worker.child.ActionExecutionWorker.execute()930: DEBUG: Starting Gradle Test Executor 2.931: 2025-12-26 15:14:35 [Test worker] org.gradle.api.internal.tasks.testing.worker.TestWorker.execute()932: INFO: Gradle Test Executor 2 started executing tests.933: 2025-12-26 15:14:38 [Test worker] org.gradle.api.internal.tasks.testing.worker.TestWorker.execute()934: INFO: Gradle Test Executor 2 finished executing tests.935: 2025-12-26 15:14:38 [Test worker] org.gradle.process.internal.worker.child.ActionExecutionWorker.execute()936: DEBUG: Completed Gradle Test Executor 2.937: > Task :jabsrv:test938: �[0K�[1;32mSUCCESS: �[39mExecuted 14 tests in 3.9s�[m939: > Task :jabsrv:check940: gradle/actions: Writing build results to /home/runner/work/_temp/.gradle-actions/build-results/__run-1766761925821.json941: [Incubating] Problems report is available at: file:///home/runner/work/jabref/jabref/build/reports/problems/problems-report.html942: FAILURE: Build failed with an exception.943: * What went wrong:944: Configuration cache problems found in this build.945: 1 problem was found storing the configuration cache.946: - Task `:jablib:generateJournalListMV` of type `dev.jbang.gradle.tasks.JBangTask`: cannot serialize Gradle script object references as these are not supported with the configuration cache.947: See https://docs.gradle.org/9.3.0-20251116230000+0000/userguide/configuration_cache_requirements.html#config_cache:requirements:disallowed_types948: See the complete report at file:///home/runner/work/jabref/jabref/build/reports/configuration-cache/44jgmsggpmw14m32dxrwu199x/7q580p5ehuixe6fgajkcv15vz/configuration-cache-report.html949: * Try:950: > Run with --stacktrace option to get the stack trace.951: > Run with --info or --debug option to get more log output.952: > Run with --scan to generate a Build Scan (powered by Develocity).953: > Get more help at https://help.gradle.org.954: BUILD FAILED in 2m 44s955: 23 actionable tasks: 21 executed, 2 from cache956: Configuration cache entry discarded with 1 problem.957: ##[error]Process completed with exit code 1.958: ##[group]Run ***@***.*** ... 1261: MedlineAPiKey: ***1262: GRADLE_OPTS: -Xmx4g1263: JAVA_OPTS: -Xmx4g1264: JAVA_HOME: /opt/hostedtoolcache/Java_Corretto_jdk/24.0.2-12.1/x641265: JAVA_HOME_24_X64: /opt/hostedtoolcache/Java_Corretto_jdk/24.0.2-12.1/x641266: GRADLE_ACTION_ID: gradle/actions/setup-gradle1267: GRADLE_USER_HOME: /home/runner/.gradle1268: GRADLE_BUILD_ACTION_SETUP_COMPLETED: true1269: GRADLE_BUILD_ACTION_CACHE_RESTORED: true1270: DEVELOCITY_INJECTION_INIT_SCRIPT_NAME: gradle-actions.inject-develocity.init.gradle1271: DEVELOCITY_INJECTION_CUSTOM_VALUE: gradle-actions1272: GITHUB_DEPENDENCY_GRAPH_ENABLED: false1273: CACHE_KEY: 0d16f28534560fd53ea706208407277c1274: ##[endgroup]1275: Formatting results...1276: No */build/test-results/*.xml files found with failing tests.1277: Post job cleanup. — Reply to this email directly, view it on GitHub <#14725 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACOFZEYSNYOXUHO72RRE234DVGJLAVCNFSM6AAAAACQB4FR32VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOJTGAYDANBZHE> . You are receiving this because you commented.Message ID: ***@***.***>

koppor · 2025-12-26T16:55:11Z

You have overwritten my changes for creating the directory

Because I included it in the plugin itself.

koppor · 2025-12-26T16:56:49Z

You have overwritten my changes for creating the directory

Because I included it in the plugin itself.

Commit removing here: f8c952a

Commit adding to plugin: koppor/jbang-gradle-plugin@660863b

Siedlerchr · 2025-12-26T19:18:20Z

I commented on the commit in the plug-in. You cannot directly use get in the plug-in, you need to use something like map Oliver Kopp ***@***.***> schrieb am Fr., 26. Dez. 2025, 17:57:

…

*koppor* left a comment (JabRef/jabref#14725) <#14725 (comment)> You have overwritten my changes for creating the directory Because I included it in the plugin itself. Commit removing here: f8c952a <f8c952a> Commit adding to plugin: ***@***.*** <koppor/jbang-gradle-plugin@660863b> — Reply to this email directly, view it on GitHub <#14725 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACOFZCBGDG5S2EKTP7UW7L4DVSGNAVCNFSM6AAAAACQB4FR32VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMOJTGEYDSMZQHE> . You are receiving this because you commented.Message ID: ***@***.***>

koppor · 2025-12-27T08:52:59Z

./gradlew --rerun-tasks -U :jablib:generateJournalListMV to refresh the plugin
Branch: "jitpack" - https://github.com/koppor/jbang-gradle-plugin/tree/jitpack

Current state:


1 problem was found storing the configuration cache.
- Task `:jablib:generateJournalListMV` of type `dev.jbang.gradle.tasks.JBangTask`: cannot serialize Gradle script object references as these are not supported with the configuration cache.
  See https://docs.gradle.org/9.3.0-20251116230000+0000/userguide/configuration_cache_requirements.html#config_cache:requirements:disallowed_types

Refs gradle/gradle#20930

* upstream/fix-caching: Fix cache update for JBang (#14727) update citeproc (#14724) Throttle calls for workflow triggering

Siedlerchr · 2025-12-27T20:22:52Z

So with the latest changes this worked

Siedlerchr · 2025-12-27T20:44:07Z

build-logic/build.gradle.kts

    implementation("com.adarshr:gradle-test-logger-plugin:4.0.0")
    implementation("com.autonomousapps:dependency-analysis-gradle-plugin:3.5.1")
    implementation("com.github.andygoossens:gradle-modernizer-plugin:1.12.0")
+    implementation("com.github.koppor:jbang-gradle-plugin:jitpack-SNAPSHOT")


Pinned commit?

Raises error when gradlew runs - plugin says jitpack-SNAPSHOT, but outputs commit id.

koppor added 5 commits December 24, 2025 11:21

Use gradle download plugin

fa04d7d

WIP: fix download

d53cb9d

Merge branch 'main' into fix-caching

4330ef3

Use latest jbang plugin

0bafff1

Remove obsolete comment

98cbfac

koppor added the dev: build-system label Dec 26, 2025

qodo-free-for-open-source-projects bot added the Review effort 2/5 label Dec 26, 2025

koppor and others added 2 commits December 26, 2025 15:37

Try other config

e6711a6

fix jbang dir

04660c6

Siedlerchr force-pushed the fix-caching branch from e6711a6 to 04660c6 Compare December 26, 2025 14:43

koppor and others added 6 commits December 26, 2025 15:50

Merge branch 'fix-caching' of github.com:JabRef/jabref into fix-caching

e78e1b3

fix path on Windows

4cdc01e

try with gradle home user dir

5f94cef

Merge branch 'fix-caching' of github.com:JabRef/jabref into fix-caching

427a287

More config

8678fc0

Remvoe workaround

f8c952a

Siedlerchr and others added 4 commits December 27, 2025 12:41

fix only if

e02244c

Merge branch 'main' into fix-caching

722bd25

fix config cache

ee06cfd

Merge remote-tracking branch 'upstream/fix-caching' into fix-caching

a0e8dfd

* upstream/fix-caching: Fix cache update for JBang (#14727) update citeproc (#14724) Throttle calls for workflow triggering

koppor enabled auto-merge December 27, 2025 20:41

koppor added this pull request to the merge queue Dec 27, 2025

Siedlerchr approved these changes Dec 27, 2025

View reviewed changes

Siedlerchr reviewed Dec 27, 2025

View reviewed changes

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 27, 2025

Siedlerchr added this pull request to the merge queue Dec 27, 2025

koppor mentioned this pull request Dec 27, 2025

Switch to release of jbang-gradle-plugin #14739

Closed

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 27, 2025

Siedlerchr added this pull request to the merge queue Dec 27, 2025

Merged via the queue into main with commit c093a77 Dec 27, 2025
54 checks passed

Siedlerchr deleted the fix-caching branch December 27, 2025 21:51

koppor mentioned this pull request Jan 12, 2026

Disable Gradle configuration cache #14847

Closed

2 tasks

Uh oh!

Enable configuration caching #14725

Enable configuration caching #14725

Uh oh!

Conversation

koppor commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Steps to test

Mandatory checks

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

qodo-free-for-open-source-projects bot commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects bot commented Dec 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Examples:

Solution Walkthrough:

Before:

After:

Uh oh!

Siedlerchr commented Dec 26, 2025

Uh oh!

Siedlerchr commented Dec 26, 2025

Uh oh!

Siedlerchr commented Dec 26, 2025 via email

Uh oh!

koppor commented Dec 26, 2025

Uh oh!

koppor commented Dec 26, 2025

Uh oh!

Siedlerchr commented Dec 26, 2025 via email

Uh oh!

koppor commented Dec 27, 2025

Uh oh!

Siedlerchr commented Dec 27, 2025

Uh oh!

Siedlerchr Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

koppor Dec 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

koppor commented Dec 26, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Dec 26, 2025 •

edited

Loading

qodo-free-for-open-source-projects bot commented Dec 26, 2025 •

edited

Loading