Javadoc verify Jenkins job failing for Netvirt-SFC decoupling patch at https://git.opendaylight.org/gerrit/c/netvirt/+/85819


JamO Luhrsen
 

+Thanh and integration-dev

I don't really know the javadocs process that's being used, but some google searching
turned up some things that make it seem like it is some problem with maven javadoc plugin
and/or java versions or some combo of those things.

here's the relevant error from the console log:



02:07:47 Command line was: /usr/lib/jvm/java-11-openjdk/bin/javadoc @options @packages

Hoping someone else knows something...

Thanks,
JamO




On 11/19/19 2:35 AM, Abhinav Gupta wrote:

Updated JamO’s email-ID

 

From: Abhinav Gupta
Sent: Tuesday, November 19, 2019 4:05 PM
To: Jamo Luhrsen <jluhrsen@...>; Luis Gomez <ecelgp@...>
Cc: srinivas.rachakonda@...; R P Karthika . <r.p.karthika@...>
Subject: Javadoc verify Jenkins job failing for Netvirt-SFC decoupling patch at https://git.opendaylight.org/gerrit/c/netvirt/+/85819

 

Hi Jamo/Luis,

I am encountering a strange Javadoc patch verify job failure (2 consecutive times), specific to the SFC-Netvirt decoupling patch. It is going on fine locally, and the Jenkins logs aren’t giving enough information to debug further.
I have already checked with Srinivas and Karthika as well.

Can you provide your expert insights?



https://jenkins.opendaylight.org/releng/job/netvirt-maven-javadoc-verify-magnesium-openjdk11/75/ : FAILURE

A shell command invoked from Jenkins build has failed, resulting in build being marked as a failure. ( https://jenkins.opendaylight.org/releng/job/netvirt-maven-javadoc-verify-magnesium-openjdk11/75/ )

Logs: https://logs.opendaylight.org/releng/vex-yul-odl-jenkins-1/netvirt-maven-javadoc-verify-magnesium-openjdk11/75

Patch set 1:Verified -1

View Change

 

Thanks,
Abhinav



Robert Varga
 

On 19/11/2019 21:34, JamO Luhrsen wrote:
+Thanh and integration-dev

I don't really know the javadocs process that's being used, but some
google searching
turned up some things that make it seem like it is some problem with
maven javadoc plugin
and/or java versions or some combo of those things.

here's the relevant error from the console log:



*02:07:47* Command line was: /usr/lib/jvm/java-11-openjdk/bin/javadoc
@options @packages

Hoping someone else knows something...
This is a rehash of a problem previously reported in Genius, see
https://git.opendaylight.org/gerrit/c/genius/+/85431.

Overall, I would like to projects move away from javadoc jobs by
creating a dedicated docs artifact --
https://github.com/opendaylight/controller/blob/master/docs/pom.xml,
which results in
https://www.javadoc.io/doc/org.opendaylight.controller/controller-docs/latest/index.html)

That has a couple of benefits:
- everything is validated in a single job (verify)
- top-level aggregator does not need to be published to Nexus
- javadoc can be properly structured
(https://github.com/opendaylight/controller/blob/master/docs/pom.xml#L302)

Bye,
Robert


Robert Varga
 

On 20/11/2019 08:20, Robert Varga wrote:
That has a couple of benefits:
- everything is validated in a single job (verify)
- top-level aggregator does not need to be published to Nexus
- javadoc can be properly structured
(https://github.com/opendaylight/controller/blob/master/docs/pom.xml#L302)
- does not tax Nexus will a gazillion small files
- allows specific classes to be excluded from javadoc

Regards,
Robert


Abhinav Gupta
 

Thanks Robert. I have pushed a patch at https://git.opendaylight.org/gerrit/c/netvirt/+/85922 similar to the one for Genius. Later ,we'll also take up separating docs like Controller project does.

Regards,
Abhinav

-----Original Message-----
From: Robert Varga <nite@...>
Sent: Wednesday, November 20, 2019 12:51 PM
To: JamO Luhrsen <jluhrsen@...>; Abhinav Gupta <abhinav.gupta@...>; Luis Gomez <ecelgp@...>
Cc: Srinivas Rachakonda <srinivas.rachakonda@...>; R P Karthika . <r.p.karthika@...>; Thanh Ha <zxiiro@...>; integration-dev@...
Subject: Re: [integration-dev] Javadoc verify Jenkins job failing for Netvirt-SFC decoupling patch at https://git.opendaylight.org/gerrit/c/netvirt/+/85819

On 19/11/2019 21:34, JamO Luhrsen wrote:
+Thanh and integration-dev

I don't really know the javadocs process that's being used, but some
google searching turned up some things that make it seem like it is
some problem with maven javadoc plugin and/or java versions or some
combo of those things.

here's the relevant error from the console log:



*02:07:47* Command line was: /usr/lib/jvm/java-11-openjdk/bin/javadoc
@options @packages

Hoping someone else knows something...
This is a rehash of a problem previously reported in Genius, see https://protect2.fireeye.com/v1/url?k=8b344df4-d7e04a58-8b340d6f-8667c4afe13e-75d0fa89a9398ca5&q=1&e=326d77e6-c4c3-4c38-bc89-ecba5ede8191&u=https%3A%2F%2Fgit.opendaylight.org%2Fgerrit%2Fc%2Fgenius%2F%2B%2F85431.

Overall, I would like to projects move away from javadoc jobs by creating a dedicated docs artifact -- https://protect2.fireeye.com/v1/url?k=7c192dbb-20cd2a17-7c196d20-8667c4afe13e-fb5037318fcc96ca&q=1&e=326d77e6-c4c3-4c38-bc89-ecba5ede8191&u=https%3A%2F%2Fgithub.com%2Fopendaylight%2Fcontroller%2Fblob%2Fmaster%2Fdocs%2Fpom.xml,
which results in
https://protect2.fireeye.com/v1/url?k=5a8c6d40-06586aec-5a8c2ddb-8667c4afe13e-5c5a5713b176f9b2&q=1&e=326d77e6-c4c3-4c38-bc89-ecba5ede8191&u=https%3A%2F%2Fwww.javadoc.io%2Fdoc%2Forg.opendaylight.controller%2Fcontroller-docs%2Flatest%2Findex.html)

That has a couple of benefits:
- everything is validated in a single job (verify)
- top-level aggregator does not need to be published to Nexus
- javadoc can be properly structured
(https://protect2.fireeye.com/v1/url?k=c018dc7b-9cccdbd7-c0189ce0-8667c4afe13e-94fa815bebabb05e&q=1&e=326d77e6-c4c3-4c38-bc89-ecba5ede8191&u=https%3A%2F%2Fgithub.com%2Fopendaylight%2Fcontroller%2Fblob%2Fmaster%2Fdocs%2Fpom.xml%23L302)

Bye,
Robert