[Proposal] build-tools module and Checkstyle

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[Proposal] build-tools module and Checkstyle

vmassol
Administrator
Hi,

I'd like to propose creating a build-tools/ module in xwiki/trunk. This
module will contain tools/files for the build. Right now it'll contain our
licenses and our checkstyle config files. In the future it can contain other
things like PMD, findbugs configs, plugins that we need for our build, etc.

This is the structure recommended by Maven2. It's the one I've used on
Cargo. You can check it out here if you want:
http://fisheye.codehaus.org/browse/cargo/cargo/trunk/build-tools

M2: The idea is to create a build-tools JAR containing all the verification
tools configs. This jar is then used by the other build module which need to
check for compliance. This is described here: http://tinyurl.com/yjlgnx

Once we have this we can start defining one by one the checkstyle rules that
we want to apply.

I'm proposing that we DON'T turn on build failure on checkstyle for the
whole project or it'll never build. What I'm suggesting instead for now (so
that everyone can get used to this - say for the coming month or so and then
we can review the strategy) is that everyone voluntarily turn on checkstyle
verification on whatever new class he writes or on existing code that he
cleans up to match the conventions. This that once we get a clean class,
anyone causing a violation on that class will result in a build failure.

Right now I have excluded all files.

I have this ready and working on my local computer. Let me know if it's ok
and I'll commit it (right now it's only bound to the Maven2 build anyway).

Once I have this committed, the next step is to agree on the checkstyle
conventions to use. I'll post another mail on that later on after we've
agreed on this one.

Thanks
-Vincent




       

       
               
___________________________________________________________________________
Yahoo! Mail réinvente le mail ! Découvrez le nouveau Yahoo! Mail et son interface révolutionnaire.
http://fr.mail.yahoo.com



--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

Re: [Proposal] build-tools module and Checkstyle

jeremi joslin-2
I'm fine with that.

Also what do you think about having a fisheyes for browsing our svn.
It's really better than viewsvn. Maybe we should ask to ObjectWeb to
replace the view svn by this.

Also, i've tried this software : https://sorcerer.dev.java.net/. It
seems very nice for looking at the code online. It creates link
between the class, so you can easily navigate between your classes.
here is a demo :
https://sorcerer.dev.java.net/nonav/sample-report/

jeremi


On 11/8/06, Vincent Massol <[hidden email]> wrote:

> Hi,
>
> I'd like to propose creating a build-tools/ module in xwiki/trunk. This
> module will contain tools/files for the build. Right now it'll contain our
> licenses and our checkstyle config files. In the future it can contain other
> things like PMD, findbugs configs, plugins that we need for our build, etc.
>
> This is the structure recommended by Maven2. It's the one I've used on
> Cargo. You can check it out here if you want:
> http://fisheye.codehaus.org/browse/cargo/cargo/trunk/build-tools
>
> M2: The idea is to create a build-tools JAR containing all the verification
> tools configs. This jar is then used by the other build module which need to
> check for compliance. This is described here: http://tinyurl.com/yjlgnx
>
> Once we have this we can start defining one by one the checkstyle rules that
> we want to apply.
>
> I'm proposing that we DON'T turn on build failure on checkstyle for the
> whole project or it'll never build. What I'm suggesting instead for now (so
> that everyone can get used to this - say for the coming month or so and then
> we can review the strategy) is that everyone voluntarily turn on checkstyle
> verification on whatever new class he writes or on existing code that he
> cleans up to match the conventions. This that once we get a clean class,
> anyone causing a violation on that class will result in a build failure.
>
> Right now I have excluded all files.
>
> I have this ready and working on my local computer. Let me know if it's ok
> and I'll commit it (right now it's only bound to the Maven2 build anyway).
>
> Once I have this committed, the next step is to agree on the checkstyle
> conventions to use. I'll post another mail on that later on after we've
> agreed on this one.
>
> Thanks
> -Vincent
>
>
>
>
>
>
>
>
> ___________________________________________________________________________
> Yahoo! Mail réinvente le mail ! Découvrez le nouveau Yahoo! Mail et son interface révolutionnaire.
> http://fr.mail.yahoo.com
>
>
>
>
> --
> You receive this message as a subscriber of the [hidden email] mailing list.
> To unsubscribe: mailto:[hidden email]
> For general help: mailto:[hidden email]?subject=help
> ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
>
>
>

--
jeremi


--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

RE: [Proposal] build-tools module and Checkstyle

vmassol
Administrator


> -----Original Message-----
> From: [hidden email] [mailto:[hidden email]] On Behalf Of
> jeremi joslin
> Sent: mercredi 8 novembre 2006 10:14
> To: [hidden email]
> Subject: Re: [xwiki-dev] [Proposal] build-tools module and Checkstyle
>
> I'm fine with that.

Cool. I'll commit it (it shouldn't break anything anyway).
 
> Also what do you think about having a fisheyes for browsing our svn.
> It's really better than viewsvn. Maybe we should ask to ObjectWeb to
> replace the view svn by this.

Yes definitely. On the fisheye issue I know very well the Cenqua guys and they've already offered to me license for all their tools for XWiki: clover, fisheye and crucible (code reviews tool).
 
> Also, i've tried this software : https://sorcerer.dev.java.net/. It
> seems very nice for looking at the code online. It creates link between
> the class, so you can easily navigate between your classes.
> here is a demo :
> https://sorcerer.dev.java.net/nonav/sample-report/

Sure, looks like a very nice javadoc report. Right now I'd like to focus on finishing the checkstyle stuff and then I can work on other stuff.

Thanks
-Vincent

> On 11/8/06, Vincent Massol <[hidden email]> wrote:
> > Hi,
> >
> > I'd like to propose creating a build-tools/ module in xwiki/trunk.
> > This module will contain tools/files for the build. Right now it'll
> > contain our licenses and our checkstyle config files. In the future
> it
> > can contain other things like PMD, findbugs configs, plugins that we
> need for our build, etc.
> >
> > This is the structure recommended by Maven2. It's the one I've used
> on
> > Cargo. You can check it out here if you want:
> > http://fisheye.codehaus.org/browse/cargo/cargo/trunk/build-tools
> >
> > M2: The idea is to create a build-tools JAR containing all the
> > verification tools configs. This jar is then used by the other build
> > module which need to check for compliance. This is described here:
> > http://tinyurl.com/yjlgnx
> >
> > Once we have this we can start defining one by one the checkstyle
> > rules that we want to apply.
> >
> > I'm proposing that we DON'T turn on build failure on checkstyle for
> > the whole project or it'll never build. What I'm suggesting instead
> > for now (so that everyone can get used to this - say for the coming
> > month or so and then we can review the strategy) is that everyone
> > voluntarily turn on checkstyle verification on whatever new class he
> > writes or on existing code that he cleans up to match the
> conventions.
> > This that once we get a clean class, anyone causing a violation on
> that class will result in a build failure.
> >
> > Right now I have excluded all files.
> >
> > I have this ready and working on my local computer. Let me know if
> > it's ok and I'll commit it (right now it's only bound to the Maven2
> build anyway).
> >
> > Once I have this committed, the next step is to agree on the
> > checkstyle conventions to use. I'll post another mail on that later
> on
> > after we've agreed on this one.
> >
> > Thanks
> > -Vincent
> >
> >
> >
> >
> >
> >
> >
> >
> >
> ______________________________________________________________________
> > _____ Yahoo! Mail réinvente le mail ! Découvrez le nouveau Yahoo!
> Mail
> > et son interface révolutionnaire.
> > http://fr.mail.yahoo.com
> >
> >
> >
> >
> > --
> > You receive this message as a subscriber of the xwiki-
> [hidden email] mailing list.
> > To unsubscribe: mailto:[hidden email]
> > For general help: mailto:[hidden email]?subject=help
> > ObjectWeb mailing lists service home page:
> > http://www.objectweb.org/wws
> >
> >
> >
>
>
> --
> jeremi





___________________________________________________________________________
D�couvrez une nouvelle fa�on d'obtenir des r�ponses � toutes vos questions !
Profitez des connaissances, des opinions et des exp�riences des internautes sur Yahoo! Questions/R�ponses
http://fr.answers.yahoo.com



--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Reply | Threaded
Open this post in threaded view
|

Re: [Proposal] build-tools module and Checkstyle

Ludovic Dubost
In reply to this post by vmassol

+1

Ludovic

Vincent Massol a écrit :

> Hi,
>
> I'd like to propose creating a build-tools/ module in xwiki/trunk. This
> module will contain tools/files for the build. Right now it'll contain our
> licenses and our checkstyle config files. In the future it can contain other
> things like PMD, findbugs configs, plugins that we need for our build, etc.
>
> This is the structure recommended by Maven2. It's the one I've used on
> Cargo. You can check it out here if you want:
> http://fisheye.codehaus.org/browse/cargo/cargo/trunk/build-tools
>
> M2: The idea is to create a build-tools JAR containing all the verification
> tools configs. This jar is then used by the other build module which need to
> check for compliance. This is described here: http://tinyurl.com/yjlgnx
>
> Once we have this we can start defining one by one the checkstyle rules that
> we want to apply.
>
> I'm proposing that we DON'T turn on build failure on checkstyle for the
> whole project or it'll never build. What I'm suggesting instead for now (so
> that everyone can get used to this - say for the coming month or so and then
> we can review the strategy) is that everyone voluntarily turn on checkstyle
> verification on whatever new class he writes or on existing code that he
> cleans up to match the conventions. This that once we get a clean class,
> anyone causing a violation on that class will result in a build failure.
>
> Right now I have excluded all files.
>
> I have this ready and working on my local computer. Let me know if it's ok
> and I'll commit it (right now it's only bound to the Maven2 build anyway).
>
> Once I have this committed, the next step is to agree on the checkstyle
> conventions to use. I'll post another mail on that later on after we've
> agreed on this one.
>
> Thanks
> -Vincent
>
>
>
>
>
>
>
>
> ___________________________________________________________________________
> Yahoo! Mail réinvente le mail ! Découvrez le nouveau Yahoo! Mail et son interface révolutionnaire.
> http://fr.mail.yahoo.com
>
>  
> ------------------------------------------------------------------------
>
>
> --
> You receive this message as a subscriber of the [hidden email] mailing list.
> To unsubscribe: mailto:[hidden email]
> For general help: mailto:[hidden email]?subject=help
> ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
>  

--
Ludovic Dubost
XPertNet: http://www.xpertnet.fr/
Blog: http://www.ludovic.org/blog/
XWiki: http://www.xwiki.com
Skype: ldubost AIM: nvludo Yahoo: ludovic






--
You receive this message as a subscriber of the [hidden email] mailing list.
To unsubscribe: mailto:[hidden email]
For general help: mailto:[hidden email]?subject=help
ObjectWeb mailing lists service home page: http://www.objectweb.org/wws