ci: set up Spotless linting in CI (#351) by KaleabArgaw · Pull Request #366 · docling-project/docling-java

KaleabArgaw · 2026-02-25T14:00:50Z

Fixes #351

edeandrea · 2026-02-25T15:16:17Z

Thanks @KaleabArgaw for this! I'll give it a look through later today or tomorrow!

I am going to have copilot do an automated review of it too, but please don't take any actions yet based on what it says. I'm really just testing it out to see if I trust it or not :)

edeandrea · 2026-02-25T15:18:34Z

@all-contributors add @KaleabArgaw for code documentation

allcontributors · 2026-02-25T15:19:28Z

@edeandrea

I've put up a pull request to add @KaleabArgaw! 🎉

Copilot

Pull request overview

This PR integrates Spotless code linting into the CI pipeline to enforce consistent code formatting across the Java codebase. The implementation uses an incremental rollout strategy via ratchetFrom("origin/main"), which checks only files changed from the main branch. This allows for gradual adoption without requiring all existing code to be reformatted immediately.

Changes:

Adds Spotless Gradle plugin (version 7.2.1) to the project dependencies
Configures Spotless in the shared Java convention plugin with basic formatting rules (remove unused imports, format annotations, trim trailing whitespace, end with newline)
Adds a new lint CI job that runs Spotless formatting checks on all pull requests
Updates CONTRIBUTING.md with instructions for running Spotless locally

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
gradle/libs.versions.toml	Adds Spotless version (7.2.1) and plugin dependency declaration to the version catalog
buildSrc/build.gradle.kts	Adds Spotless Gradle plugin as a buildSrc dependency, making it available to convention plugins
buildSrc/src/main/kotlin/docling-java-shared.gradle.kts	Applies Spotless plugin and configures it with ratchetFrom strategy and basic Java formatting rules
.github/workflows/build.yml	Adds new `lint` job that checks out code with full history (fetch-depth: 0), runs spotlessApply, and verifies no formatting changes are needed
CONTRIBUTING.md	Documents new Spotless commands (`spotlessCheck` and `spotlessApply`) for contributors

buildSrc/src/main/kotlin/docling-java-shared.gradle.kts

github-actions · 2026-02-25T15:23:53Z

:java_duke: JaCoCo coverage report

Overall Project	46.08%	🔴

There is no coverage information present for the Files changed

github-actions · 2026-02-25T15:23:56Z

	Tests	Passed ✅	Skipped	Failed
Gradle Test Results (all modules & JDKs)	936 ran	936 passed	0 skipped	0 failed

Test	Result
No test annotations available

View Gradle Test Results (all modules & JDKs)

github-actions · 2026-02-25T15:23:57Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

edeandrea

See comments in-line.

I'd also like @ThomasVitale to take a look.

.github/workflows/build.yml

edeandrea · 2026-02-25T15:30:16Z

buildSrc/src/main/kotlin/docling-java-shared.gradle.kts


+spotless {
+  // Roll out linting incrementally by checking only files changed from main.
+  ratchetFrom("origin/main")


This is causing a build failure in the docs module that needs to be investigated.

edeandrea · 2026-02-25T15:33:44Z

buildSrc/src/main/kotlin/docling-java-shared.gradle.kts

+    trimTrailingWhitespace()
+    endWithNewline()
+  }
+}


I haven't read up on spotless and its configuration - is there a way to specify the configuration outside of the gradle dsl? And is there a way to get it to respect what we have in .editorconfig?

Ideally I'd prefer control over formatting/etc to be defined in a single place, whether thats .editorconfig or somewhere else. It would also be nice if when a user loads the project into an IDE, the formatting rules are respected by the IDE. Anything we can do to make that easier is a win.

Yeah we can govern it using .editorconfig

Does it use .editorconfig by default if you don't add any additional config for java?

I see in the documentation it works that way for kotlin (ktlint)

github-actions · 2026-02-25T15:51:02Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

github-actions · 2026-02-26T13:13:30Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

CONTRIBUTING.md

gradle/libs.versions.toml

github-actions · 2026-02-26T18:04:08Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

edeandrea · 2026-02-26T18:05:21Z

Hi @KaleabArgaw thank you so much for this!

I've just downloaded & built this PR locally and purposefully introduced some things that should break the spotless check. When I run ./gradlew --no-daemon --console=plain spotlessCheck it doesn't seem to find any violations, even though I have introduced clear violations against things inside .editorconfig.

╰─ ./gradlew --no-daemon --console=plain clean spotlessCheck                   
To honour the JVM settings for this build a single-use Daemon process will be forked. For more on this, please refer to https://docs.gradle.org/9.3.1/userguide/gradle_daemon.html#sec:disabling_the_daemon in the Gradle documentation.
Daemon will be stopped at the end of the build 
> Task :buildSrc:checkKotlinGradlePluginConfigurationErrors SKIPPED
> Task :buildSrc:generateExternalPluginSpecBuilders UP-TO-DATE
> Task :buildSrc:extractPrecompiledScriptPluginPlugins UP-TO-DATE
> Task :buildSrc:compilePluginsBlocks UP-TO-DATE
> Task :buildSrc:generatePrecompiledScriptPluginAccessors UP-TO-DATE
> Task :buildSrc:generateScriptPluginAdapters UP-TO-DATE
> Task :buildSrc:compileKotlin UP-TO-DATE
> Task :buildSrc:compileJava NO-SOURCE
> Task :buildSrc:compileGroovy NO-SOURCE
> Task :buildSrc:pluginDescriptors UP-TO-DATE
> Task :buildSrc:processResources UP-TO-DATE
> Task :buildSrc:classes UP-TO-DATE
> Task :buildSrc:jar UP-TO-DATE
> Task :docling-core:clean
> Task :docling-serve-api:clean
> Task :docling-serve-client:clean
> Task :docling-testcontainers:clean
> Task :docling-version-tests:clean
> Task :docs:clean UP-TO-DATE
> Task :test-report-aggregation:clean UP-TO-DATE
> Task :spotlessInternalRegisterDependencies UP-TO-DATE
> Task :docling-core:spotlessJava
> Task :docling-core:spotlessJavaCheck
> Task :docling-core:spotlessCheck
> Task :docling-serve-api:spotlessJava
> Task :docling-serve-api:spotlessJavaCheck
> Task :docling-serve-api:spotlessCheck
> Task :docling-serve-client:spotlessJava
> Task :docling-serve-client:spotlessJavaCheck
> Task :docling-serve-client:spotlessCheck
> Task :docling-testcontainers:spotlessJava
> Task :docling-testcontainers:spotlessJavaCheck
> Task :docling-testcontainers:spotlessCheck
> Task :docling-version-tests:spotlessJava
> Task :docling-version-tests:spotlessJavaCheck
> Task :docling-version-tests:spotlessCheck

) Signed-off-by: Kaleab Argaw <kaleruha16@gmail.com>

KaleabArgaw · 2026-02-26T19:13:14Z

Hey @edeandrea i removed the on build fail that's why you can check now locally.

github-actions · 2026-02-27T01:02:26Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

edeandrea requested a review from Copilot February 25, 2026 15:15

Copilot started reviewing on behalf of edeandrea February 25, 2026 15:15 View session

allcontributors bot mentioned this pull request Feb 25, 2026

docs: add KaleabArgaw as a contributor for code, and doc #367

Merged

Copilot AI reviewed Feb 25, 2026

View reviewed changes

buildSrc/src/main/kotlin/docling-java-shared.gradle.kts Show resolved Hide resolved

edeandrea force-pushed the ci/351-code-linting branch from f41a996 to 0169818 Compare February 25, 2026 15:26

edeandrea reviewed Feb 25, 2026

View reviewed changes

edeandrea requested a review from ThomasVitale February 25, 2026 15:35

edeandrea mentioned this pull request Feb 26, 2026

Set up code linting as part of DevOps processes #351

Open

edeandrea reviewed Feb 26, 2026

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

edeandrea reviewed Feb 26, 2026

View reviewed changes

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

KaleabArgaw force-pushed the ci/351-code-linting branch 2 times, most recently from feb364e to ad6b1db Compare February 26, 2026 15:05

ci: set up spotless checks as dedicated PR workflow (docling-project#351

67ee6e3

) Signed-off-by: Kaleab Argaw <kaleruha16@gmail.com>

KaleabArgaw force-pushed the ci/351-code-linting branch from ad6b1db to 67ee6e3 Compare February 26, 2026 19:08

Conversation

KaleabArgaw commented Feb 25, 2026 • edited by edeandrea Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

edeandrea commented Feb 25, 2026

Uh oh!

edeandrea commented Feb 25, 2026

Uh oh!

allcontributors bot commented Feb 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

github-actions bot commented Feb 25, 2026

:java_duke: JaCoCo coverage report

Uh oh!

github-actions bot commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 25, 2026

Uh oh!

edeandrea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

edeandrea Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

edeandrea Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KaleabArgaw Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

edeandrea Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 25, 2026

Uh oh!

github-actions bot commented Feb 26, 2026

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 26, 2026

Uh oh!

edeandrea commented Feb 26, 2026

Uh oh!

KaleabArgaw commented Feb 26, 2026

Uh oh!

github-actions bot commented Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

KaleabArgaw commented Feb 25, 2026 •

edited by edeandrea

Loading

github-actions bot commented Feb 25, 2026 •

edited

Loading

edeandrea Feb 25, 2026 •

edited

Loading

edeandrea Feb 26, 2026 •

edited

Loading