Skip to content
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

[chore] Move Javadoc failures away from end-to-end test phase #408

Closed
ches opened this issue Jan 5, 2020 · 2 comments
Closed

[chore] Move Javadoc failures away from end-to-end test phase #408

ches opened this issue Jan 5, 2020 · 2 comments
Labels
area/infra good first issue Good for newcomers help wanted Extra attention is needed kind/housekeeping priority/p2 wontfix This will not be worked on

Comments

@ches
Copy link
Member

ches commented Jan 5, 2020

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:

  1. For tests, run mvn package with -Dmaven.javadoc.skip
  2. 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:

  1. Run some type of Coding Standards check early in PR build steps, including invoking a goal from the Javadoc plugin
  2. 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.

@ches
Copy link
Member Author

ches commented 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 check or lint to contain things like Javadoc and Spotless check (or just bind existing ones to an early lifecycle phase like validate, 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
Copy link

stale bot commented 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.

@stale stale bot added the wontfix This will not be worked on label Mar 29, 2020
@stale stale bot closed this as completed Apr 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/infra good first issue Good for newcomers help wanted Extra attention is needed kind/housekeeping priority/p2 wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants