Make the build independent from linked javadoc websites

Description

None

Environment

None

Activity

Show:
Yoann Rodière
February 4, 2020, 8:19 AM
Edited

Javadoc generation in particular relies on fetching data from linked javadoc, such as Lucene's, in order to generate proper links. See https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#links

When Lucene's website is down (happened today for all of Apache's websites), or has a transient failure (happens from time to time, say every month or so), we get this warning:

And since we fail on Javadoc warnings, the whole build fails:

Failing on javadoc warnings makes sense: it means we won't generate invalid javadoc, or at least it makes it less likely. What makes less sense is relying on external infrastructure (other than our CI and Maven Central) during our build.

Ideally we would generate links without actually accessing the website.

offlineLinks looks like what we need. We could extract the javadoc of Lucene/etc. from Maven artifacts, and use detectJavaApiLink for the Java API.

Assignee

Yoann Rodière

Reporter

Yoann Rodière

Labels

None

Suitable for new contributors

None

Feedback Requested

None

Components

Fix versions

Priority

Major
Configure