[Hawkular-dev] Coming to Parent: publishing JavaDoc and sources via Maven

[Peter Palaga]

Hi Stefan,

The motivation for this change is to get source and JavaDoc loaded 
automagically by IDEs. Is that not an aim worth pursuing?
The change was proposed by mazz https://issues.jboss.org/browse/HAWKULAR-86

More inline...

On 03/30/2015 04:29 PM, Stefan Negrea wrote:
> Hello Peter,
>
> Wewould like to disable (or not have it all) in the Hawkular Metrics
> project.
> Hawkular Metrics iterates at a fast pace and this would be a
> huge distraction due to the rapidly changing design and
> implementation. At this stage we are focused on building a great
> project so agile tooling and minimal requirements are paramount.

Could you please be more specific what kind of distraction you have in 
mind?
To put it more clearly, JavaDoc and source jars are generated only when 
"release" profile is active. I would not say running those two plugins 
is a part of anyone's daily routine. Releases done by CI taking a couple 
of seconds longer is outweighted by the benefit of getting the sources 
in IDEs.
Perhaps it is also necessary to note that the plugins as configured in 
https://github.com/hawkular/hawkular-parent-pom/pull/20 *just work* - 
they produce what they are supposed to and they do not shout loudly 
about the quality. The quality checks for JavaDoc are explicitly 
disabled by -Xdoclint:none and it is an open question if this should be 
changed in the future. Maybe it is just here that you vote against?

> Can you please provide documentation on how to disable this at the
> project level?

Are you sure you need it, given all the above?

Best,

Peter

>
> Thank you, Stefan
>
> ----- Original Message -----
>> From: "Peter Palaga" <ppalaga at redhat.com> To:
>> hawkular-dev at lists.jboss.org Sent: Monday, March 30, 2015 8:37:17
>> AM Subject: [Hawkular-dev] Coming to Parent: publishing JavaDoc and
>> sources via	Maven
>>
>> Hi *, there is a question about handling JavaDoc checks violations
>> at the bottom.
>>
>> I have added maven-javadoc-plugin and maven-source-plugin to the
>> new "release" profile in Hawkular Parent.
>> https://github.com/hawkular/hawkular-parent-pom/pull/20
>>
>> I have tested the above only with Hawkular Bus. Therefore, please
>> test the setup with your Hawkular component: * Make whatever is
>> appropriate to make your component use the pom from
>> https://github.com/hawkular/hawkular-parent-pom/pull/20 * Invoke
>>
>> mvn clean install -Prelease
>>
>> * Figure out, how many "[WARNING] Javadoc Warnings" are there. *
>> Look into target folders if *-javadoc.jar and *-sources.jar files
>> were generated
>>
>>
>> == Handling JavaDoc checks violations
>>
>> The present setup turns all javadoc violations into warnings using
>> -Xdoclint:none [1]. I can only say that there *are* violations in
>> Bus.
>>
>> I think that we should aim at having no violations at all - i.e.
>> that the components should be given a week or two to fix and that
>> we should switch to -Xdoclint:all after that. WDYT?
>>
>> More about -Xdoclint can be found in [2].
>>
>> Thanks,
>>
>> Peter
>>
>> [1]
>> https://github.com/hawkular/hawkular-parent-pom/commit/d54a8d03b4ef251d594f1cc4ff3fadfa4a1d4dd3#diff-600376dffeb79835ede4a0b285078036R110
>>
>>
>>
[2] http://docs.oracle.com/javase/8/docs/technotes/tools/unix/javac.html
>> _______________________________________________ hawkular-dev
>> mailing list hawkular-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>>
> _______________________________________________ hawkular-dev mailing
> list hawkular-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hawkular-dev
>