chore: Recommend CheckStyle version 8.24 or higher #8259
Merged
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
spena
reviewed
Oct 18, 2021
CONTRIBUTING.md
Outdated
| @@ -164,7 +164,7 @@ You can set up IntelliJ for CheckStyle. First install the CheckStyle IDEA plugin | |||
|
|
|||
| IntelliJ → Preferences → Tools → CheckStyle | |||
|
|
|||
| In top left corner select CheckStyle version 8.18 (newer versions fail to parse the provided XML) | |||
| In top left corner select CheckStyle version 8.24 or newer (older versions fail to parse the provided XML) | |||
There was a problem hiding this comment.
8.44 is the latest version used - https://github.com/confluentinc/common/blob/master/pom.xml#L100
spena
approved these changes
Oct 18, 2021
Gerrrr
force-pushed
the
chore-checkstyle-version
branch
from
6ee931a
to
db3abb2
Compare
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.
Description
Contributing.md guide suggests to select
CheckStyle version 8.18 (newer versions fail to parse the provided XML). Importingcheckstyle.xmlwith this version fails withcom.puppycrawl.tools.checkstyle.api.CheckstyleException: LineLength is not allowed as a child in Checker. It does work, however, with versions 8.24 or higher (e.g. 9.0). I suppose that the configuration changed since the guide was written.Testing done
I tested the change manually - checked the earliest CheckStyle version that allows importing the xml.
Reviewer checklist