-
Notifications
You must be signed in to change notification settings - Fork 74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Checkstyle and JaCoCo to fix build #637
Merged
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
>properties `allowMissingThrowsTags`, `allowUndeclaredRTE` [...] should >be just removed from configs. >Behavior will change as there will be less violations in code, such >properties did not work well so their removal should be ok, as there >will be less false-positives. See: * https://checkstyle.sourceforge.io/releasenotes.html#Release_8.28 * checkstyle/checkstyle#7329
Replaced by [`MissingJavadocMethod`](https://checkstyle.org/config_javadoc.html#MissingJavadocMethod). That is, missing Javadoc is now allowed by default. See: * https://checkstyle.sourceforge.io/releasenotes.html#Release_8.21 * checkstyle/checkstyle#6703
Since the property `allowMissingThrowsTags` has been removed, `validateThrows` now means you can no longer omit `@throws` in Javadoc. Whenever a method declares `throws`, it must be documented. Furthermore, Checkstyle authors say: >If you need to validate `@throws` please enable property >`validateThrows but please read documentation as there some >limitations - >https://checkstyle.org/config_javadoc.html#JavadocMethod . >Old documentation is at >https://checkstyle.sourceforge.io/version/8.27/config_javadoc.html#JavadocMethod
Looks okay to me, we can continue tweaking Checkstyle from a successful build as a baseline. |
Michael1993
approved these changes
May 18, 2022
To handle Java 18 bytecode (version 62).
I just updated JaCoCo too. The previous build errors shadowed:
|
beatngu13
changed the title
Update Checkstyle and fix build
Update Checkstyle and JaCoCo to fix build
May 18, 2022
nipafx
approved these changes
May 19, 2022
Bukama
pushed a commit
that referenced
this pull request
Jun 5, 2022
Bukama
pushed a commit
to Bukama/junit-pioneer
that referenced
this pull request
Sep 20, 2022
…oneer#646) This PR documents the use of transitive dependencies Pioneer related on. related: junit-pioneer#637 PR: junit-pioneer#646
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.
Please pay attention to the commit messages, which include links to the corresponding Checkstyle release notes / PRs.
Regarding the message of the last commit, which removes
validateThrows
:Keeping
validateThrows
would cause the following 8 violations:File /.../junit-pioneer/src/main/java/org/junitpioneer/internal/PioneerPreconditions.java
@throws
für 'PreconditionViolationException'.@throws
für 'PreconditionViolationException'.@throws
für 'PreconditionViolationException'.@throws
für 'PreconditionViolationException'.@throws
für 'PreconditionViolationException'.@throws
für 'PreconditionViolationException'.File
/.../junit-pioneer/src/main/java/org/junitpioneer/jupiter/cartesian/CartesianMethodArgumentsProvider.java
@throws
für 'Exception'.File
/.../junit-pioneer/src/main/java/org/junitpioneer/jupiter/cartesian/CartesianParameterArgumentsProvider.java
@throws
für 'Exception'.If we want to keep
validateThrows
– which would be a trade-off as we are no longer able to omit@throws
(allowMissingThrowsTags
has been removed) – I'm happy to create a separate issue. But I would suggest to first get this PR merged, so thatmain
is stable again.Side note: I have added the
merge-ready
label by myself to see if experimentals are passing.Proposed commit message:
PR checklist
The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.
Documentation (general)
.adoc
file in thedocs
folder, e.g.docs/report-entries.adoc
.adoc
file references demo insrc/demo/java
instead of containing code blocks as text.adoc
files)Documentation (new extension)
docs/docs-nav.yml
navigation has an entry for the new extensionpackage-info.java
contains information about the new extensionCode
Contributing
README.md
mentions the new contribution (real name optional)