On Sat, 25 Jun 2022 at 00:43, Gilles Sadowski <gillese...@gmail.com> wrote:
>
> [1] I'm a bit surprised that the build succeeds despite the missing
> comments.
>
So am I. There are a lot of warnings:
Compilation has 2 warnings each about unchecked casts and unchecked method
invocation.
PMD: 115 warnings.
This plugin is not set to fail on violation due to problems throughout the
numbers build. But it does spot all the missing javadoc comments.
Javadoc:
2 warnings for incorrect tags. This plugin could be configured to fail on
warning. The default is failOnError=true and failOnWarning=false. I checked
the rest of the project and there are no warnings. So I changed this to
failOnWarning.
Jacoco:
Rule violations for classes covered and methods covered. But it does not
fail the build. I checked the old travis profile and it did not set
the build to fail when coverage is not met. The travis profile just
submitted the report to coveralls.
There is a note in the pom:
<!-- Set to true when coverage goals are achieved -->
<commons.jacoco.haltOnFailure>false</commons.jacoco.haltOnFailure>
I have set this to true since we have met coverage goals across the rest of
the numbers project.
Note: The coverage report from codecov is not yet complete so has not been
posted to the PR. It does show the drop in coverage:
https://codecov.io/github/apache/commons-numbers/commit/203cbc6a505a1d004297115414b2188e21427219
Checkstyle:
Checkstyle plugin is configured to failOnViolation. So it is not
complaining about lack of comments. We are using the following rules:
InvalidJavadocPosition,JavadocMethod,JavadocType,JavadocVariable,JavadocStyle
So the failure of checkstyle to fail is strange. If I take an existing file
and make some formatting changes it fails the build. If I delete a tag from
the javadoc it fails the build. If I delete the entire javadoc then this
passes. So checkstyle checks the existing javadoc but does not fail when
javadoc is missing. This requires further investigation.
You will have to rebase the PR on master to pick up the pom changes. Then
run the default maven goal (in the complex module) and fix the issues.
Alex
