strongly suggest move maven-javadoc-plugin from *site *to *build*

It is better to let the committer handle this when they get these codes,
than letting the release manager handle this.


Olivier Lamy <ol...@apache.org> 于2022年2月27日周日 08:46写道:

> Thanks for the PRs.
> I'd like to start a discussion rather than some comments in PRs lost in the
> middle of gh notification flood.
> I have started some POC including more "live" reporting in Jenkins (by live
> I mean this could be at least for every commit to master).
> Perso, I'm not reading some reports from the site produced at release time
> because it's simply too late as nothing can be done to improve anything.
> Who is really reading those reports after a release has been made?
> Code analysis is interesting when we develop/change the code to improve it
> (i.e monitoring change of master branch) but once release is done do we
> really care?
> Well this can be a long discussion :)
> Anyway the POC now includes reports such jacoco somes static analysis (pmd,
> checkstyle, spotbugs, errorprone) and some logs parsing (maven warning,
> compiler warnings)
> See here
>
> https://ci-maven.apache.org/job/Maven/job/maven-compiler-plugin-test-olamy/job/ci-reporting/15/linux-jdk11/
>
> such reports do not fail the build and can show improvement of the master
> branch.
> It's a POC only available now in a maven-compiler-plugin
> branch ci-reporting and the common jenkins build with this PR (
> https://github.com/apache/maven-jenkins-lib/pull/3)
> if someone need some more reports more formats are available here
>
> https://github.com/jenkinsci/analysis-model/blob/master/SUPPORTED-FORMATS.md
>
>
> comments welcome.
>
>
>
> On Sat, 26 Feb 2022 at 03:41, Slawomir Jaranowski <s.jaranow...@gmail.com>
> wrote:
>
> > Hi,
> >
> > I've created a few PRs for removing some reports from Maven site. [1]
> >
> > I think that such reports do not bring any useful information for project
> > documentations, but have influence to site build time.
> >
> > [1] https://github.com/apache/maven-parent/pulls
> >
> >
> > pt., 25 lut 2022 o 03:11 Olivier Lamy <ol...@apache.org> napisał(a):
> >
> > > Hi,
> > >
> > > On Fri, 25 Feb 2022 at 07:57, Slawomir Jaranowski <
> > s.jaranow...@gmail.com>
> > > wrote:
> > >
> > > > Hi
> > > > In next version of Maven parent
> > > >  - detectLinks from javadoc configurations was removed, so javadoc
> will
> > > not
> > > > download remote resource, it was fails many times in this case
> > > >  - findbugs was removed - it also took a lot of time
> > > >
> > > > My proposition is to remove from reports:
> > > >   - surefire
> > > >   - checkstyle
> > > >   - pmd
> > > >   - taglist
> > > >   - invoker
> > > >   and finally - jxr
> > > >
> > > > chekstyle is used during build,
> > > > if we want to use pmd should be included in build
> > > > any other tests result are reported on jenkins for each build, I
> don't
> > > see
> > > > benefit of such in documentations
> > > >
> > >
> > > I tend to agree to remove reports which are already part of the build
> and
> > > fail the build in case of issues (such checkstyle, surefire, invoker).
> > > Because at the end reports are just empty and finally do not provide
> much
> > > more interesting information.
> > > What about having those reports in Jenkins (for at least only one
> > > combination).
> > > But which one? Jenkins reporting can support a lot of tools
> > >
> > >
> >
> https://github.com/jenkinsci/analysis-model/blob/master/SUPPORTED-FORMATS.md
> > > I feel sometimes some reports are generating some false negative
> > warnings,
> > > But at least it will be here if someone wants to have a look but would
> > not
> > > fail a normal build and not make extra noise
> > > Not sure which tools could be interesting? spotbugs, compiler warnings,
> > > what else?
> > >
> > >
> > >
> > > >
> > > > and of course I can change GH action to build site only on one node
> > > >
> > >
> > > agree on that maybe for only 1 combination such linux/jdk 1.8/maven
> last
> > > version?
> > >
> > >
> > > >
> > > > czw., 24 lut 2022 o 22:49 Tamás Cservenák <ta...@cservenak.net>
> > > > napisał(a):
> > > >
> > > > > Olivier,
> > > > >
> > > > > please remove all the Jenkins checks from all of the Maven builds
> you
> > > > added
> > > > > without asking anyone about adding it.
> > > > > The release manager should ensure beforehand it is all ok, if not,
> > try
> > > to
> > > > > fix it, if the issue is bigger, still can decide to rollback the
> > > change.
> > > > >
> > > > > Thanks
> > > > > T
> > > > >
> > > > >
> > > > >
> > > > > On Thu, Feb 24, 2022 at 10:14 PM Tamás Cservenák <
> > ta...@cservenak.net>
> > > > > wrote:
> > > > >
> > > > > > Building javadoc is slow and very fragile (fetches remote
> > resources,
> > > > > chews
> > > > > > on stuff etc).
> > > > > > Why not have a savvy release manager ensuring it is building, and
> > > > calling
> > > > > > out PR authors to fix it?
> > > > > > The Worst can happen is rel mgr rollback the chnge if the PR
> author
> > > is
> > > > > > unresponsive.
> > > > > >
> > > > > > On Thu, Feb 24, 2022 at 10:01 PM Olivier Lamy <ol...@apache.org>
> > > > wrote:
> > > > > >
> > > > > >> Please read what I say. I'm just mentioning javadoc as
> > contributors
> > > > > >> and committers can fail the build with bad javadoc but we will
> not
> > > see
> > > > > it.
> > > > > >>
> > > > > >> On Fri, 25 Feb 2022 at 06:47, Tamás Cservenák <
> > ta...@cservenak.net>
> > > > > >> wrote:
> > > > > >>
> > > > > >> > Building everything for each commit is insane.
> > > > > >> >
> > > > > >> > Also, I find a release mgr that does NOT check is site
> building
> > > > > >> beforehand
> > > > > >> > release as sloppy.
> > > > > >> >
> > > > > >> > Hence, building everything on each commit just to suit sloppy
> > > > release
> > > > > >> mgrs
> > > > > >> > is insane IMHO.
> > > > > >> >
> > > > > >> > My 5 cents.
> > > > > >> >
> > > > > >> > T
> > > > > >> >
> > > > > >> > On Thu, Feb 24, 2022 at 9:30 PM Olivier Lamy <
> ol...@apache.org>
> > > > > wrote:
> > > > > >> >
> > > > > >> > > Sounds good.
> > > > > >> > >  But who has never released something and having javadoc
> > failing
> > > > in
> > > > > >> the
> > > > > >> > > middle of the release or the site generation failing once
> tag
> > > done
> > > > > and
> > > > > >> > > artifacts staged… I find this a pain 😀
> > > > > >> > >
> > > > > >> > > Maybe only testing javadoc works at least ?
> > > > > >> > >
> > > > > >> > > Btw I agree some reports could be removed
> > > > > >> > >
> > > > > >> > > On Fri, 25 Feb 2022 at 6:24 am, <herve.bout...@free.fr>
> > wrote:
> > > > > >> > >
> > > > > >> > > > and reporting profile was done for this:
> > > > > >> > > > - without reporting profile, just light site generation
> > > > > >> > > > - with reporting profile, full documentation site
> > > > > >> > > >
> > > > > >> > > > disabling reporting profile for CI should do the job
> > > > > >> > > >
> > > > > >> > > > ----- Mail original -----
> > > > > >> > > > De: "herve boutemy" <herve.bout...@free.fr>
> > > > > >> > > > À: "Maven Developers List" <dev@maven.apache.org>
> > > > > >> > > > Envoyé: Jeudi 24 Février 2022 21:21:45
> > > > > >> > > > Objet: Re: Review of used reports for Maven project sites.
> > > > > >> > > >
> > > > > >> > > > done on GH and Jenkins, then on each commit?
> > > > > >> > > > we're heating oceans for nothing
> > > > > >> > > >
> > > > > >> > > > IMHO, we need to differentiate CI vs release
> documentation:
> > CI
> > > > > >> should
> > > > > >> > be
> > > > > >> > > > much lighter than release
> > > > > >> > > >
> > > > > >> > > > ----- Mail original -----
> > > > > >> > > > De: "Slawomir Jaranowski" <s.jaranow...@gmail.com>
> > > > > >> > > > À: "Maven Developers List" <dev@maven.apache.org>
> > > > > >> > > > Envoyé: Jeudi 24 Février 2022 20:53:49
> > > > > >> > > > Objet: Re: Review of used reports for Maven project sites.
> > > > > >> > > >
> > > > > >> > > > Yes is done after release but also on jenkins for plugins
> > and
> > > on
> > > > > GH
> > > > > >> > > builds
> > > > > >> > > >
> > > > > >> > > > czw., 24 lut 2022 o 20:43 <herve.bout...@free.fr>
> > napisał(a):
> > > > > >> > > >
> > > > > >> > > > > full site building with reports enabled (through
> reporting
> > > > > >> profile)
> > > > > >> > is
> > > > > >> > > > > just done after release, isn't it?
> > > > > >> > > > >
> > > > > >> > > > > ----- Mail original -----
> > > > > >> > > > > De: "Slawomir Jaranowski" <s.jaranow...@gmail.com>
> > > > > >> > > > > À: "Maven Developers List" <dev@maven.apache.org>
> > > > > >> > > > > Envoyé: Jeudi 24 Février 2022 20:24:56
> > > > > >> > > > > Objet: Review of used reports for Maven project sites.
> > > > > >> > > > >
> > > > > >> > > > > Hi,
> > > > > >> > > > >
> > > > > >> > > > > Building the Maven site takes a long time for our
> > projects.
> > > > > >> > > > >
> > > > > >> > > > > Before releasing the next version of maven-parent, I
> have
> > a
> > > > > >> proposal
> > > > > >> > to
> > > > > >> > > > > review used Maven site reports.
> > > > > >> > > > >
> > > > > >> > > > > So
> > > > > >> > > > >
> > > > > >> > > > >  - without reporting profile, standard
> > > > > >> > > maven-project-info-reports-plugin
> > > > > >> > > > -
> > > > > >> > > > > build very quick - no problems
> > > > > >> > > > >
> > > > > >> > > > > - with reporting profile:
> > > > > >> > > > >   - surefire   -  require test phase - can have
> influence
> > on
> > > > > build
> > > > > >> > time
> > > > > >> > > > >   - checkstyle
> > > > > >> > > > >   - pmd
> > > > > >> > > > >   - jxr - needed by other reports
> > > > > >> > > > >   - taglist
> > > > > >> > > > >   - javadoc - require generate-sources
> > > > > >> > > > >
> > > > > >> > > > > - for plugins and extensions additional invoker report
> is
> > > > added.
> > > > > >> > > > >
> > > > > >> > > > > I starting to think what of benefit we have, who is
> > looking
> > > at
> > > > > >> > reports
> > > > > >> > > > > like: surefire, checkstyle, pmd, taglist
> > > > > >> > > > > Maybe they are redundant - tests, checkstyle
> verification
> > > > simply
> > > > > >> must
> > > > > >> > > > pass
> > > > > >> > > > >
> > > > > >> > > > > --
> > > > > >> > > > > Sławomir Jaranowski
> > > > > >> > > > >
> > > > > >> > > > >
> > > > > >>
> > > ---------------------------------------------------------------------
> > > > > >> > > > > To unsubscribe, e-mail:
> dev-unsubscr...@maven.apache.org
> > > > > >> > > > > For additional commands, e-mail:
> > dev-h...@maven.apache.org
> > > > > >> > > > >
> > > > > >> > > > >
> > > > > >> > > >
> > > > > >> > > > --
> > > > > >> > > > Sławomir Jaranowski
> > > > > >> > > >
> > > > > >> > > >
> > > > > >>
> > > ---------------------------------------------------------------------
> > > > > >> > > > To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
> > > > > >> > > > For additional commands, e-mail:
> dev-h...@maven.apache.org
> > > > > >> > > >
> > > > > >> > > >
> > > > > >> > >
> > > > > >> >
> > > > > >>
> > > > > >
> > > > >
> > > >
> > > >
> > > > --
> > > > Sławomir Jaranowski
> > > >
> > >
> >
> >
> > --
> > Sławomir Jaranowski
> >
>

Reply via email to