chore: Add CI check for method/constructor Javadoc quality #3907
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
Genius ...
This reverts commit 07ed849.
It will never be 0, when no errors are found the regex will simply find nothing
slarse
changed the title
slarse
changed the title
slarse
changed the title
monperrus
changed the title
|
Great infrastructure contribution! Thanks @slarse |
Merged
woutersmeenk
pushed a commit
to woutersmeenk/spoon
that referenced
this pull request
Aug 29, 2021
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.
Fix #3906
This PR adds a script
chore/ci-checkstyle-javadoc.shwhich runs Checkstyle on the project, looking for Javadoc style problems on public methods/constructors. It counts the amount of Checkstyle errors on the current branch, and on the master branch, and fails the build if the current branch has more errors.The quality check can be seen here: https://github.com/INRIA/spoon/pull/3907/checks#step:9:10
Here is the checkstyle rule used JavadocMethod. We're using default settings with the exception that we only check public methods/constructors (default is to check all visibilities).