You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Jason van Zyl <ja...@takari.io> on 2014/05/18 19:04:51 UTC
Let's fix the Rat Check usability fail
Right now though we require all files to have license headers we do not run the check to verify this by default.
It kept dinging me until I turned it on by default in Maven core. Someone currently trying to contribute has no idea this is a requirement and is not told so because it doesn't run by default. If it's required how about we just run all the time everywhere?
I would like to change the POMs so that it always runs. Having to run RAT separately is a usability fail. The chances of anyone contributing knowing they have to run it are pretty close to zero.
Anyone see a reason not to always run it?
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
http://twitter.com/jvanzyl
http://twitter.com/takari_io
---------------------------------------------------------
We all have problems. How we deal with them is a measure of our worth.
-- Unknown
Re: Let's fix the Rat Check usability fail
Posted by Stephen Connolly <st...@gmail.com>.
+1
On Sunday, 18 May 2014, Jason van Zyl <ja...@takari.io> wrote:
> Right now though we require all files to have license headers we do not
> run the check to verify this by default.
>
> It kept dinging me until I turned it on by default in Maven core. Someone
> currently trying to contribute has no idea this is a requirement and is not
> told so because it doesn't run by default. If it's required how about we
> just run all the time everywhere?
>
> I would like to change the POMs so that it always runs. Having to run RAT
> separately is a usability fail. The chances of anyone contributing knowing
> they have to run it are pretty close to zero.
>
> Anyone see a reason not to always run it?
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder, Apache Maven
> http://twitter.com/jvanzyl
> http://twitter.com/takari_io
> ---------------------------------------------------------
>
> We all have problems. How we deal with them is a measure of our worth.
>
> -- Unknown
>
>
>
>
>
>
>
>
>
>
--
Sent from my phone
Re: Let's fix the Rat Check usability fail
Posted by Dennis Lundberg <de...@apache.org>.
Hi,
Sorry for being late to the discussion. Here are my thoughts on the subject.
I agree that we should turn on Rat by default for all our projects
within Apache Maven. There are still a bunch of projects that
currently fail the Rat check, see private area in svn for more info.
Some of them fail because Rat 0.10 doesn't correctly identify certain
file types. Others fail because they have files without license
headers. These need to either add license headers or add exclusions to
the project's configuration.
I've been tweaking Rat to cover everything we need when it comes to
file type detection and 0.11-SNAPSHOT is working fine for me. Let me
try to push for a release of Rat so that we can take advantage of the
improvements in the newer version.
On Sun, May 18, 2014 at 7:04 PM, Jason van Zyl <ja...@takari.io> wrote:
> Right now though we require all files to have license headers we do not run the check to verify this by default.
>
> It kept dinging me until I turned it on by default in Maven core. Someone currently trying to contribute has no idea this is a requirement and is not told so because it doesn't run by default. If it's required how about we just run all the time everywhere?
>
> I would like to change the POMs so that it always runs. Having to run RAT separately is a usability fail. The chances of anyone contributing knowing they have to run it are pretty close to zero.
>
> Anyone see a reason not to always run it?
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder, Apache Maven
> http://twitter.com/jvanzyl
> http://twitter.com/takari_io
> ---------------------------------------------------------
>
> We all have problems. How we deal with them is a measure of our worth.
>
> -- Unknown
>
>
>
>
>
>
>
>
>
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Let's fix the Rat Check usability fail
Posted by Hervé BOUTEMY <he...@free.fr>.
+1
I think we should have rat on every build by default, and only avoid it if it
ever cause real performance issue (which doesn't seem to happen)
https://issues.apache.org/jira/browse/MPOM-52 created
Regards,
Hervé
Le dimanche 18 mai 2014 14:38:56 Jason van Zyl a écrit :
> It's the site phase itself that takes a long time.
>
> On the commons-vfs core module it's takes little time:
>
> https://gist.github.com/jvanzyl/69c038c0f100803f10db
>
> I argue that the release should always be in a ready state to release, all
> requirements need to be met at all times in order for this to be the case.
> Aside from the surprise factor at release time when something doesn't work.
> On May 18, 2014, at 2:15 PM, Bernd Eckenfels <ec...@zusammenkunft.net> wrote:
> > Currently the Rat Report in the Site phase of commons-vfs takes enormous
> > time, for really no good use when the commits are reviewed anyway (and it
> > has all kinds of excludes and warnings you manually need to check).
> >
> > So I argue it would be better to run it only in relase (candidate) builds.
> > Not sure if the same process applies to maven development.
> >
> > Greetings
> > Bernd
> >
> > Am 18.05.2014 um 19:43 schrieb "Jason Pyeron" <jp...@pdinc.us>:
> >>> -----Original Message-----
> >>> From: Jason van Zyl
> >>> Sent: Sunday, May 18, 2014 13:05
> >>>
> >>> Right now though we require all files to have license headers
> >>> we do not run the check to verify this by default.
> >>
> >> Can it be turned off by option?
> >>
> >>> It kept dinging me until I turned it on by default in Maven
> >>> core. Someone currently trying to contribute has no idea this
> >>> is a requirement and is not told so because it doesn't run by
> >>> default. If it's required how about we just run all the time
> >>> everywhere?
> >>
> >> What phase?
> >>
> >>> I would like to change the POMs so that it always runs.
> >>> Having to run RAT separately is a usability fail. The chances
> >>> of anyone contributing knowing they have to run it are pretty
> >>> close to zero.
> >>>
> >>> Anyone see a reason not to always run it?
> >>
> >> How much time do they take (add)?
> >>
> >> -Jason
> >>
> >> --
> >> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> >> - -
> >> - Jason Pyeron PD Inc. http://www.pdinc.us -
> >> - Principal Consultant 10 West 24th Street #100 -
> >> - +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
> >> - -
> >> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> >> This message is copyright PD Inc, subject to license 20080407P00.
> >>
> >>
> >>
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> >> For additional commands, e-mail: dev-help@maven.apache.org
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder, Apache Maven
> http://twitter.com/jvanzyl
> http://twitter.com/takari_io
> ---------------------------------------------------------
>
> You are never dedicated to something you have complete confidence in.
> No one is fanatically shouting that the sun is going to rise tomorrow.
> They know it is going to rise tomorrow. When people are fanatically
> dedicated to political or religious faiths or any other kind of
> dogmas or goals, it's always because these dogmas or
> goals are in doubt.
>
> -- Robert Pirzig, Zen and the Art of Motorcycle Maintenance
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Let's fix the Rat Check usability fail
Posted by Bernd Eckenfels <ec...@zusammenkunft.net>.
Hello,
I was speaking about the Rat report for the whole project (which is the parent of the core). The Rat-Plugin in the site creation seems to run for 107s on my machine (the Javadoc runs 17s).
But maybe I read the output wrong, maven logs can be quite confusing:
73090 [INFO] Generating "Rat Report" report --- apache-rat-plugin:0.10
73112 [DEBUG] Adding plexus default exclusions...
73112 [DEBUG] Adding exclusions often needed by Maven projects...
73112 [DEBUG] Adding exclusions often needed by projects developed in Eclipse...
73112 [DEBUG] Adding exclusions often needed by projects developed in IDEA...
73113 [DEBUG] Finished creating list of implicit excludes.
73113 [INFO] 54 implicit excludes (use -debug for more details).
73114 [INFO] Exclude: site-content/**
73114 [INFO] Exclude: .pmd
73114 [INFO] Exclude: src/site/resources/download_*.cgi
73114 [INFO] Exclude: src/site/resources/profile.*
73895 [DEBUG] Excluded 4081 resources:
...
73984 [DEBUG] - excluded target\site\xref-test\stylesheet.css
73984 [INFO] 206 resources included (use -debug for more details)
...
73987 [DEBUG] - included test.txt
Warning: org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser: Property 'http://www.oracle.com/xml/jaxp/properties/entityExpansionLimit' is not recognized.
Compiler warnings:
WARNING: 'org.apache.xerces.jaxp.SAXParserImpl: Property 'http://javax.xml.XMLConstants/property/accessExternalDTD' is not recognized.'
Warning: org.apache.xerces.parsers.SAXParser: Feature 'http://javax.xml.XMLConstants/feature/secure-processing' is not recognized.
Warning: org.apache.xerces.parsers.SAXParser: Property 'http://javax.xml.XMLConstants/property/accessExternalDTD' is not recognized.
Warning: org.apache.xerces.parsers.SAXParser: Property 'http://www.oracle.com/xml/jaxp/properties/entityExpansionLimit' is not recognized.
180110 [DEBUG] Multipage report: 0 subreports
180134 [DEBUG] Velocimacro : added #relreplace( text ) : source = META-INF/maven/site.vm
...
180145 [DEBUG] Velocimacro : added #forkMeOnGitHub( ) : source = META-INF/maven/site.vm
180205 [INFO] Generating "Checkstyle" report --- maven-checkstyle-plugin:2.9.1
Greetings
Bernd
Am Sun, 18 May 2014 14:38:56 -0400
schrieb Jason van Zyl <ja...@takari.io>:
> It's the site phase itself that takes a long time.
>
> On the commons-vfs core module it's takes little time:
>
> https://gist.github.com/jvanzyl/69c038c0f100803f10db
>
> I argue that the release should always be in a ready state to
> release, all requirements need to be met at all times in order for
> this to be the case. Aside from the surprise factor at release time
> when something doesn't work.
>
> On May 18, 2014, at 2:15 PM, Bernd Eckenfels <ec...@zusammenkunft.net>
> wrote:
>
> > Currently the Rat Report in the Site phase of commons-vfs takes
> > enormous time, for really no good use when the commits are reviewed
> > anyway (and it has all kinds of excludes and warnings you manually
> > need to check).
> >
> > So I argue it would be better to run it only in relase (candidate)
> > builds. Not sure if the same process applies to maven development.
> >
> > Greetings
> > Bernd
> >
> > Am 18.05.2014 um 19:43 schrieb "Jason Pyeron" <jp...@pdinc.us>:
> >
> >>> -----Original Message-----
> >>> From: Jason van Zyl
> >>> Sent: Sunday, May 18, 2014 13:05
> >>>
> >>> Right now though we require all files to have license headers
> >>> we do not run the check to verify this by default.
> >>
> >> Can it be turned off by option?
> >>
> >>> It kept dinging me until I turned it on by default in Maven
> >>> core. Someone currently trying to contribute has no idea this
> >>> is a requirement and is not told so because it doesn't run by
> >>> default. If it's required how about we just run all the time
> >>> everywhere?
> >>
> >> What phase?
> >>
> >>>
> >>> I would like to change the POMs so that it always runs.
> >>> Having to run RAT separately is a usability fail. The chances
> >>> of anyone contributing knowing they have to run it are pretty
> >>> close to zero.
> >>>
> >>> Anyone see a reason not to always run it?
> >>
> >> How much time do they take (add)?
> >>
> >> -Jason
> >>
> >> --
> >> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> >> - -
> >> - Jason Pyeron PD Inc. http://www.pdinc.us -
> >> - Principal Consultant 10 West 24th Street #100 -
> >> - +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
> >> - -
> >> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> >> This message is copyright PD Inc, subject to license 20080407P00.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Let's fix the Rat Check usability fail
Posted by Jason van Zyl <ja...@takari.io>.
It's the site phase itself that takes a long time.
On the commons-vfs core module it's takes little time:
https://gist.github.com/jvanzyl/69c038c0f100803f10db
I argue that the release should always be in a ready state to release, all requirements need to be met at all times in order for this to be the case. Aside from the surprise factor at release time when something doesn't work.
On May 18, 2014, at 2:15 PM, Bernd Eckenfels <ec...@zusammenkunft.net> wrote:
> Currently the Rat Report in the Site phase of commons-vfs takes enormous time, for really no good use when the commits are reviewed anyway (and it has all kinds of excludes and warnings you manually need to check).
>
> So I argue it would be better to run it only in relase (candidate) builds. Not sure if the same process applies to maven development.
>
> Greetings
> Bernd
>
> Am 18.05.2014 um 19:43 schrieb "Jason Pyeron" <jp...@pdinc.us>:
>
>>> -----Original Message-----
>>> From: Jason van Zyl
>>> Sent: Sunday, May 18, 2014 13:05
>>>
>>> Right now though we require all files to have license headers
>>> we do not run the check to verify this by default.
>>
>> Can it be turned off by option?
>>
>>> It kept dinging me until I turned it on by default in Maven
>>> core. Someone currently trying to contribute has no idea this
>>> is a requirement and is not told so because it doesn't run by
>>> default. If it's required how about we just run all the time
>>> everywhere?
>>
>> What phase?
>>
>>>
>>> I would like to change the POMs so that it always runs.
>>> Having to run RAT separately is a usability fail. The chances
>>> of anyone contributing knowing they have to run it are pretty
>>> close to zero.
>>>
>>> Anyone see a reason not to always run it?
>>
>> How much time do they take (add)?
>>
>> -Jason
>>
>> --
>> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
>> - -
>> - Jason Pyeron PD Inc. http://www.pdinc.us -
>> - Principal Consultant 10 West 24th Street #100 -
>> - +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
>> - -
>> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
>> This message is copyright PD Inc, subject to license 20080407P00.
>>
>>
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>> For additional commands, e-mail: dev-help@maven.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
http://twitter.com/jvanzyl
http://twitter.com/takari_io
---------------------------------------------------------
You are never dedicated to something you have complete confidence in.
No one is fanatically shouting that the sun is going to rise tomorrow.
They know it is going to rise tomorrow. When people are fanatically
dedicated to political or religious faiths or any other kind of
dogmas or goals, it's always because these dogmas or
goals are in doubt.
-- Robert Pirzig, Zen and the Art of Motorcycle Maintenance
Re: Let's fix the Rat Check usability fail
Posted by Bernd Eckenfels <ec...@zusammenkunft.net>.
Currently the Rat Report in the Site phase of commons-vfs takes enormous time, for really no good use when the commits are reviewed anyway (and it has all kinds of excludes and warnings you manually need to check).
So I argue it would be better to run it only in relase (candidate) builds. Not sure if the same process applies to maven development.
Greetings
Bernd
Am 18.05.2014 um 19:43 schrieb "Jason Pyeron" <jp...@pdinc.us>:
>> -----Original Message-----
>> From: Jason van Zyl
>> Sent: Sunday, May 18, 2014 13:05
>>
>> Right now though we require all files to have license headers
>> we do not run the check to verify this by default.
>
> Can it be turned off by option?
>
>> It kept dinging me until I turned it on by default in Maven
>> core. Someone currently trying to contribute has no idea this
>> is a requirement and is not told so because it doesn't run by
>> default. If it's required how about we just run all the time
>> everywhere?
>
> What phase?
>
>>
>> I would like to change the POMs so that it always runs.
>> Having to run RAT separately is a usability fail. The chances
>> of anyone contributing knowing they have to run it are pretty
>> close to zero.
>>
>> Anyone see a reason not to always run it?
>
> How much time do they take (add)?
>
> -Jason
>
> --
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> - -
> - Jason Pyeron PD Inc. http://www.pdinc.us -
> - Principal Consultant 10 West 24th Street #100 -
> - +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
> - -
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> This message is copyright PD Inc, subject to license 20080407P00.
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Let's fix the Rat Check usability fail
Posted by Jason van Zyl <ja...@takari.io>.
On May 18, 2014, at 1:43 PM, Jason Pyeron <jp...@pdinc.us> wrote:
>> -----Original Message-----
>> From: Jason van Zyl
>> Sent: Sunday, May 18, 2014 13:05
>>
>> Right now though we require all files to have license headers
>> we do not run the check to verify this by default.
>>
>
> Can it be turned off by option?
>
It has an option to ignore the errors:
http://creadur.apache.org/rat/apache-rat-plugin/check-mojo.html
>> It kept dinging me until I turned it on by default in Maven
>> core. Someone currently trying to contribute has no idea this
>> is a requirement and is not told so because it doesn't run by
>> default. If it's required how about we just run all the time
>> everywhere?
>
> What phase?
It runs in the validate phase.
>
>>
>> I would like to change the POMs so that it always runs.
>> Having to run RAT separately is a usability fail. The chances
>> of anyone contributing knowing they have to run it are pretty
>> close to zero.
>>
>> Anyone see a reason not to always run it?
>
> How much time do they take (add)?
Negligible in the grand scheme of things. I don't notice on Maven core which is still relatively small. For anything here I don't think anyone is going to notice it running.
>
> -Jason
>
> --
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> - -
> - Jason Pyeron PD Inc. http://www.pdinc.us -
> - Principal Consultant 10 West 24th Street #100 -
> - +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
> - -
> -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
> This message is copyright PD Inc, subject to license 20080407P00.
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
http://twitter.com/jvanzyl
http://twitter.com/takari_io
---------------------------------------------------------
believe nothing, no matter where you read it,
or who has said it,
not even if i have said it,
unless it agrees with your own reason
and your own common sense.
-- Buddha
RE: Let's fix the Rat Check usability fail
Posted by Jason Pyeron <jp...@pdinc.us>.
> -----Original Message-----
> From: Jason van Zyl
> Sent: Sunday, May 18, 2014 13:05
>
> Right now though we require all files to have license headers
> we do not run the check to verify this by default.
>
Can it be turned off by option?
> It kept dinging me until I turned it on by default in Maven
> core. Someone currently trying to contribute has no idea this
> is a requirement and is not told so because it doesn't run by
> default. If it's required how about we just run all the time
> everywhere?
What phase?
>
> I would like to change the POMs so that it always runs.
> Having to run RAT separately is a usability fail. The chances
> of anyone contributing knowing they have to run it are pretty
> close to zero.
>
> Anyone see a reason not to always run it?
How much time do they take (add)?
-Jason
--
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- -
- Jason Pyeron PD Inc. http://www.pdinc.us -
- Principal Consultant 10 West 24th Street #100 -
- +1 (443) 269-1555 x333 Baltimore, Maryland 21218 -
- -
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
This message is copyright PD Inc, subject to license 20080407P00.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org