Stop versioning Checkstyle IDE config #87285
Merged
+27
−8
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
Closes elastic#86945. The IntelliJ Checkstyle plugin likes to modify its configuration file unecessarily, which creates friction for developers because they have the revert these changes. Instead, stop versioning the config file and instead update the `configureIdeCheckstyle` task to copy the required content into place.
pugnascotia
added
>refactoring
:Delivery/Tooling
|
Pinging @elastic/es-delivery (Team:Delivery) |
mark-vieira
approved these changes
Jun 1, 2022
| // the result to version control, because the plugin has a habit of modifying the file and | ||
| // replacing the `$PROJECT_DIR$` placeholders, which developers must then revert. | ||
| Files.copy( | ||
| Paths.get(file("${resources}/checkstyle-idea.xml").getPath()), |
There was a problem hiding this comment.
We should add these as inputs/outputs of this task.
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.
Closes #86945.
The IntelliJ Checkstyle plugin likes to modify its configuration file
unecessarily, which creates friction for developers because they have
the revert these changes.
Instead, stop versioning the config file and instead update the
configureIdeCheckstyletask to copy the required content into place.