Skip to content

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

@ches

Description

@ches

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions