Moved from #407 (comment)
Currently the maven-javadoc-plugin is bound to the jar goal, so it triggers when end-to-end tests run mvn package.
An end-to-end test phase is a frustrating time to fail on malformatted Javadoc… (and generating them is a bit of a waste of time outside of release preparation). Perhaps we can do something like:
- For tests, run
mvn package with -Dmaven.javadoc.skip
- Worry about Javadoc cleanup at release preparation time, automated in a release build
Or if you'd like for contributors to maintain error-free Javadoc proactively:
- Run some type of Coding Standards check early in PR build steps, including invoking a goal from the Javadoc plugin
- For tests, run
mvn package with -Dmaven.javadoc.skip
Javadoc skip could be enabled by default in the root build, and disabled in a release profile.
Moved from #407 (comment)
Currently the maven-javadoc-plugin is bound to the
jargoal, so it triggers when end-to-end tests runmvn package.An end-to-end test phase is a frustrating time to fail on malformatted Javadoc… (and generating them is a bit of a waste of time outside of release preparation). Perhaps we can do something like:
mvn packagewith-Dmaven.javadoc.skipOr if you'd like for contributors to maintain error-free Javadoc proactively:
mvn packagewith-Dmaven.javadoc.skipJavadoc skip could be enabled by default in the root build, and disabled in a release profile.