I continued my experiments with javadocs and a next hurdle was an external link to Hadoop documentation https://hadoop.apache.org/docs/current/api/ . Javadoc build job scans logs for javadoc-specific warnings and it founds any it fails build. But there were many failures in the past in a form: "javadoc: warning - Error fetching URL: https://hadoop.apache.org/docs/current/api/"; Consequently we ignore such lines. But a check we do seems unfair as we currently have malformed javadocs. Currently we use a following regexp to find javadoc warnings: "^\[WARNING\] javadoc: warning - (?!Error fetching URL).*$"
I suppose a proper strategy is to search for "Javadoc Warnings" substring. But we must deal with a Hadoop external link. I made an experiment and removed "<link>https://hadoop.apache.org/docs/current/api/</link>" tag from parent/pom.xml and fixed all other existed javadoc warnings. I received a green build result [1] (in an experimental build job). Do we really need this link to Hadoop javadocs? What do you think? [1] https://ci.ignite.apache.org/buildConfiguration/IgniteTests24Java8_ExperimentJavadoc?branch=pull%2F7356%2Fhead&buildTypeTab=overview&mode=builds пт, 24 янв. 2020 г. в 16:06, Ivan Pavlukhin <vololo...@gmail.com>: > > Actually, I got stuck with a question what do modules like > ignite-hibernate mean from a javadoc standpoint. It seems that modules > sharing same packages and classes cannot be aggregated into valid > javadoc bundle. And actually this problem should be solved as well > (modularization?). But I suppose that it is closer to a release > process rather than daily TC check. > > So, my current understanding is: > 1. Javadoc job should be fixed to reveal problems (with code links). > 2. "javadoc" profile is not needed for daily TC check, but it > highlights some release-related problems. > > пт, 24 янв. 2020 г. в 15:44, Maxim Muzafarov <mmu...@apache.org>: > > > > Folks, > > > > > > It's true that my simple assumption (to include Javadoc profile) will > > not work by reasons mentioned by Petr. I've tested it under a new > > experimental suite [1] which I've created earlier. We will always have > > such warnings due to we have multiple modules with the same package > > declarations (e.g. ignite-hibernate_5.1, hibernate_4.2, hibernate_5.3 > > modules and the same for others like spring-data): > > > > [WARNING] Javadoc: warning - Multiple sources of package comments > > found for package "org.apache.ignite.cache.store.hibernate" > > > > So, if we build all modules it's not correct to fail the whole JavaDoc > > suite by existing such warnings in the suite logs. > > > > > > I'm still thinking of how can we handle all such cases and I don't > > have an easy solution for now. At least we can do checks with two > > steps: > > 1. build with Javadoc profile ignore warnings (fail on an error) > > 2. build and check that there is no warnings for ignite-core module > > > > Thoughts? > > > > > > [1] > > https://ci.ignite.apache.org/viewLog.html?buildId=4927599&buildTypeId=IgniteTests24Java8_JavadocExtended > > > > > > > > On Fri, 24 Jan 2020 at 13:47, Ivan Pavlukhin <vololo...@gmail.com> wrote: > > > > > > Petr, > > > > > > Thank you for that detail! Unfortunately I do not know how to fix it > > > easily. > > > > > > Also I found that even without "javadoc" profile we miss some javadoc > > > problems. I believe that it can be fixed by updating post-build > > > javadoc checking condition. See below what problems do we miss (and > > > there are a bit more in full logs): > > > [05:08:51]W: [Step 2/2] [WARNING] Javadoc Warnings > > > [05:08:51]W: [Step 2/2] [WARNING] > > > /opt/buildagent/work/7bc1c54bc719b67c/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/GridCacheContext.java:2351: > > > warning - Tag @link: reference not found: > > > GridDistributedCacheAdapter.GlobalRemoveAllJob > > > [05:08:51]W: [Step 2/2] [WARNING] > > > /opt/buildagent/work/7bc1c54bc719b67c/modules/core/src/main/java/org/apache/ignite/internal/processors/cache/GridCacheContext.java:2351: > > > warning - Tag @link: reference not found: > > > GridDistributedCacheAdapter.GlobalRemoveAllJob > > > > > > пт, 24 янв. 2020 г. в 11:56, Petr Ivanov <mr.wei...@gmail.com>: > > > > > > > > We could not because of multiple hibernate modules, what is considered > > > > from the javadoc's point as warning, that always fails test. > > > > > > > > > > > > > On 24 Jan 2020, at 11:02, Ivan Pavlukhin <vololo...@gmail.com> wrote: > > > > > > > > > > Maxim, > > > > > > > > > > I suppose we can try to enable "javadoc" profile for a corresponding > > > > > job. Are there any objections to do so? > > > > > > > > > > пн, 20 янв. 2020 г. в 13:25, Ivan Pavlukhin <vololo...@gmail.com>: > > > > >> > > > > >> Maxim, > > > > >> > > > > >> From the first glance it seems that "javadoc" profile was really > > > > >> missed. Are there any other problems except springdata22? If no then > > > > >> we can add the profile. Also it is interesting how it influence on > > > > >> execution time? > > > > >> > > > > >> пн, 13 янв. 2020 г. в 16:53, Maxim Muzafarov <mmu...@apache.org>: > > > > >>> > > > > >>> Igniters, > > > > >>> > > > > >>> > > > > >>> I've run locally maven command according to DEVNOTES: > > > > >>> > > > > >>> mvn initialize -Pjavadoc > > > > >>> > > > > >>> and it fails due to: 'Other Packages' section should not be present, > > > > >>> all packages should have corresponding documentation groups. The > > > > >>> reason of that is a newly added `org.apache.ignite.springdata22` > > > > >>> package [1] is missing in maven-javadoc-plugin configuration [2]. > > > > >>> > > > > >>> > > > > >>> We have Javadoc Suite [3] but it not checks such issues due to > > > > >>> `javadoc` maven profile required to be enabled. > > > > >>> Should we enable `javadoc` profile for this suite? > > > > >>> Any other thoughts? > > > > >>> > > > > >>> [1] https://issues.apache.org/jira/browse/IGNITE-12259 > > > > >>> [2] https://issues.apache.org/jira/browse/IGNITE-12528 > > > > >>> [3] > > > > >>> https://ci.ignite.apache.org/viewType.html?buildTypeId=IgniteTests24Java8_Javadoc&branch_IgniteTests24Java8=%3Cdefault%3E&tab=buildTypeStatusDiv > > > > >> > > > > >> > > > > >> > > > > >> -- > > > > >> Best regards, > > > > >> Ivan Pavlukhin > > > > > > > > > > > > > > > > > > > > -- > > > > > Best regards, > > > > > Ivan Pavlukhin > > > > > > > > > > > > > -- > > > Best regards, > > > Ivan Pavlukhin > > > > -- > Best regards, > Ivan Pavlukhin -- Best regards, Ivan Pavlukhin
