Repository navigation
[chore] Move Javadoc failures away from end-to-end test phase #408
Description
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 packagewith-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 packagewith-Dmaven.javadoc.skip
Javadoc skip could be enabled by default in the root build, and disabled in a release profile.
Activity
ches commentedon Jan 8, 2020
@woop prefers the latter direction per #407 (comment).
I can take a stab at updating Maven config to avoid Javadoc generation except in a release profile, and either defining a meta-goal like
mvn checkorlintto contain things like Javadoc and Spotless check (or just bind existing ones to an early lifecycle phase likevalidate, whatever works best, but I don't want to block people from compiling in day-to-day dev because of formatting compliance, that's failing too fast).I'll probably need a pointer or help to actually make a Prow build step for that, but that should be a small matter when we get there.
stale commentedon Mar 29, 2020
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
chore: Bump Python dependency locks, UI/website deps, and cap Power-s…