Enable up-to-date checking in Maven plugin by default #1621
Conversation
This file contains 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
lutovich
commented
Mar 12, 2023
| checker = UpToDateChecker.forProject(project, indexFile, formatters, getLog()); | ||
| } else { | ||
| getLog().info("Up-to-date checking disabled"); |
There was a problem hiding this comment.
Changed logging slightly because disabled up-to-date checking will be an uncommon path that requires explicit configuration. Thus, the plugin should log something on such an uncommon path
Up-to-date checking has been supported for a long time. We haven't received any negative feedback about it. Neo4j is an example project that has up-to-date checking enabled to improve performance and haven't had problems with it: https://github.com/neo4j/neo4j/blob/6ebc409772cea13354adb6a11aab4ed38da9d53e/pom.xml#L745-L747. It should be safe to enable up-to-date checking for all users of the Spotless Maven plugin. This commit also fixes the problem where plugin execution would fail on a parent of a multimodule Maven project with up-to-date checking enabled. A parent project can configure Spotless as: ```xml <build> <pluginManagement> <plugins> <plugin> <groupId>com.diffplug.spotless</groupId> <artifactId>spotless-maven-plugin</artifactId> ... </plugin> </plugins> </pluginManagement> </build> ``` It allows child projects to inherit plugin's version and configuration but the plugin is not enables by default. PluginFingerprint did not handle such configuration correctly. It could only handle a simple configuration like: ```xml <build> <plugins> <plugin> <groupId>com.diffplug.spotless</groupId> <artifactId>spotless-maven-plugin</artifactId> ... </plugin> </plugins> </build> ``` And failed with "Spotless plugin absent from the project" error for a multimodule parent project with Spotless in `<pluginManagement>`.
lutovich
force-pushed
the
maven-up-to-date-checking-enabled-by-default
branch
from
1a7530b
to
24abb54
Compare
|
Published in |
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Up-to-date checking has been supported for a long time. We haven't received any negative feedback about it. Neo4j is an example project that has up-to-date checking enabled to improve performance and haven't had problems with it: link.
It should be safe to enable up-to-date checking for all users of the Spotless Maven plugin.
This PR also fixes a problem where plugin execution would fail on a parent of a multimodule Maven project with up-to-date checking enabled. A parent project can configure Spotless as:
It allows child projects to inherit plugin's version and configuration but the plugin is not enables by default.
PluginFingerprintdid not handle such configuration correctly. It could only handle a simple configuration like:And failed with "Spotless plugin absent from the project" error for a multimodule parent project with Spotless in
<pluginManagement>.