Declare formatter version to avoid spotless choosing a version#1151
Merged
MarkEWaite merged 1 commit intojenkinsci:masterfrom Jun 26, 2025
Merged
Conversation
diffplug/spotless#2503 (comment) indicates that spotless chooses a formatter version based on the JDK running the formatting process. The spotless maintainer recommends that we declare a formatter version explicitly so that the formatter won't change based on the JDK version. Testing done: MAVEN_OPTS=-Djansi.force=true mvn -B -Dstyle.color=always -ntp clean verify In the winstone repository (where we saw the issue): Reverted the change that made the formatting independent of Java version in b95111923002d82598d4d85f67f40fa6170dda5e and then added explicit spotless version definition to the pom file so that I could confirm that changing Java versions does not change the formatting. MarkEWaite/winstone@78ea965 has the details . ~/bin/use_java17 mvn spotless:apply git status . ~/bin/use_java21 mvn spotless:apply git status
MarkEWaite
added a commit
to MarkEWaite/pom
that referenced
this pull request
Jun 8, 2025
diffplug/spotless#2503 (comment) indicates that spotless chooses a formatter version based on the JDK running the formatting process. The spotless maintainer recommends that we declare a formatter version explicitly so that the formatter won't change based on the JDK version. Testing done: In this repository: mvn clean install versions:display-plugin-updates In the winstone repository (where we saw the issue): Reverted the change that made the formatting independent of Java version in b95111923002d82598d4d85f67f40fa6170dda5e and then added explicit spotless version definition to the pom file so that I could confirm that changing Java versions does not change the formatting. MarkEWaite/winstone@78ea965 has the details . ~/bin/use_java17 mvn spotless:apply git status . ~/bin/use_java21 mvn spotless:apply git status Matching pull request in plugin pom: * jenkinsci/plugin-pom#1151
6 tasks
timja
approved these changes
Jun 8, 2025
jglick
reviewed
Jun 24, 2025
| <palantirJavaFormat /> | ||
| <palantirJavaFormat> | ||
| <!-- Declare version so that spotless does not choose a version based on JDK version --> | ||
| <!-- https://github.com/diffplug/spotless/issues/2503#issuecomment-2953146277 --> |
Member
There was a problem hiding this comment.
jglick
approved these changes
Jun 24, 2025
6 tasks
jglick
reviewed
Jun 26, 2025
| <palantirJavaFormat> | ||
| <!-- Declare version so that spotless does not choose a version based on JDK version --> | ||
| <!-- https://github.com/diffplug/spotless/issues/2503#issuecomment-2953146277 --> | ||
| <version>2.67.0</version> |
Member
There was a problem hiding this comment.
Where is this version number coming from? It does not seem to match https://github.com/diffplug/spotless/blob/2d32ccd3ef17e80f456f7bd3587846f2734bca71/lib/src/main/java/com/diffplug/spotless/java/PalantirJavaFormatStep.java#L32 (diffplug/spotless#2447 picking up palantir/palantir-java-format#1211).
Member
There was a problem hiding this comment.
I suppose the point is merely that this is some arbitrary recent version, rather than picking one of two distinct much older versions depending on the JRE.
Contributor
Author
There was a problem hiding this comment.
It was the most recent release of palantir-java-format as of the day that I created this pull request, as reported by https://mvnrepository.com/artifact/com.palantir.javaformat/palantir-java-format . Sadly, a newer release arrived the day after this commit was created and then another release happened several weeks after that.
Member
There was a problem hiding this comment.
Not a problem I think, just confirming.
MarkEWaite
added a commit
to jenkinsci/pom
that referenced
this pull request
Jun 26, 2025
diffplug/spotless#2503 (comment) indicates that spotless chooses a formatter version based on the JDK running the formatting process. The spotless maintainer recommends that we declare a formatter version explicitly so that the formatter won't change based on the JDK version. Testing done: In this repository: mvn clean install versions:display-plugin-updates In the winstone repository (where we saw the issue): Reverted the change that made the formatting independent of Java version in b95111923002d82598d4d85f67f40fa6170dda5e and then added explicit spotless version definition to the pom file so that I could confirm that changing Java versions does not change the formatting. MarkEWaite/winstone@78ea965 has the details . ~/bin/use_java17 mvn spotless:apply git status . ~/bin/use_java21 mvn spotless:apply git status Matching pull request in plugin pom: * jenkinsci/plugin-pom#1151
Member
|
Caused #1162 |
Member
|
Caused #1169 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Declare formatter version to avoid spotless choosing a version
diffplug/spotless#2503 (comment) indicates that spotless chooses a formatter version based on the JDK running the formatting process. We intentionally run our tests with both JDK 17 and JDK 21. In some source code, that causes source code formatting to fail the build on one JDK version when it passes on the other JDK version.
Examples of the failure and workarounds that have been applied:
The spotless maintainer recommends that we declare a formatter version explicitly so that the formatter won't change based on the JDK version.
Matching pull request in Jenkins core pom:
Testing done
In the winstone repository (where we saw the issue):
Reverted the change that made the formatting independent of Java version in b95111923002d82598d4d85f67f40fa6170dda5e and then added explicit spotless version definition to the pom file so that I could confirm that changing Java versions does not change the formatting.
MarkEWaite/winstone@78ea965 has the details
The formatting was unchanged in both cases.
Submitter checklist