[hibernate-dev] Checkstyle and ORM

[Steve Ebersole]

ORM master is now enforcing checkstyle.  The CI builds will fail if you
commit anything that was deemed a severity of error/high.  The only part
missing there is headers, which I will follow up with once I hear back from
Hardy.

On Mon, May 18, 2015 at 3:07 PM, Steve Ebersole <steve at hibernate.org> wrote:

> Hardy, do you happen to still have your sed script for updating these file
> headers?
>
> On Mon, May 18, 2015 at 2:48 PM, Sanne Grinovero <sanne at hibernate.org>
> wrote:
>
>> On 18 May 2015 at 19:44, Steve Ebersole <steve at hibernate.org> wrote:
>> > And see, this[1] is exactly the kind of thing I always try to avoid...
>> Why
>> > did y'all decide on that approach?
>>
>> Personally I think the main reason is pride. Some contributors
>> explicitly asked me if it was ok to add their names, after they had
>> contributed several nice patches.
>>
>> FYI I don't update it at each and every release, but when I do I do it
>> in batches by using the git log: append to existing file, pipe to sort
>> and pipe to uniq, remove some aliases for same person so it's a low
>> burden.
>>
>> I have no idea if there are legal strings attached.
>>
>> Sanne
>>
>>
>>
>> >
>> >
>> > [1]
>> https://github.com/hibernate/hibernate-search/blob/master/copyright.txt
>> >
>> > On Mon, May 18, 2015 at 10:33 AM, Emmanuel Bernard <
>> emmanuel at hibernate.org>
>> > wrote:
>> >>
>> >> +1 I thought it was in already :)
>> >>
>> >> > On 18 mai 2015, at 17:20, Steve Ebersole <steve at hibernate.org>
>> wrote:
>> >> >
>> >> > Sorry hit send too soon :(
>> >> >
>> >> > Anyway.. I assume it is because we know this information from commit
>> >> > history?
>> >> >
>> >> > As far as the ORM one, I propose a similar change.  Any objections?
>> >> >
>> >> > On Mon, May 18, 2015 at 10:14 AM, Steve Ebersole <
>> steve at hibernate.org>
>> >> > wrote:
>> >> >
>> >> >> As far as the file header, I have often thought of condensing our
>> ORM
>> >> >> one
>> >> >> so that is awesome information.  For my own curiosity did Richard
>> give
>> >> >> you
>> >> >> a reason that the copyright statement is not necessary?
>> >> >>
>> >> >> On Mon, May 18, 2015 at 9:58 AM, Sanne Grinovero <
>> sanne at hibernate.org>
>> >> >> wrote:
>> >> >>
>> >> >>>> On 18 May 2015 at 15:23, Emmanuel Bernard <emmanuel at hibernate.org
>> >
>> >> >>>> wrote:
>> >> >>>> Note that custom checkstyle rule implementations does not fare
>> well
>> >> >>> with IDE checkstyle rules enforcement.
>> >> >>>> I can't make it reliably work on search and OGM.
>> >> >>>
>> >> >>> As far as I remember the problem was related with having the
>> >> >>> customisations as part of the project which is being built.
>> >> >>> I'd hope one day we could publish a common set of rules by
>> releasing
>> >> >>> the custom as an independent project, consumed by all. We could try
>> >> >>> that already for some projects, and see if the others catch up
>> >> >>> eventually? They don't even have to use the same XML so there is
>> some
>> >> >>> room for customizing which rules exactly each project wants to
>> >> >>> enforce.
>> >> >>>
>> >> >>> I'm not sure if that will resolve your problem but it's worth
>> trying;
>> >> >>> it could also slightly speed up the builds by a couple of seconds,
>> as
>> >> >>> you wouldn't have to rebuild the checkstyle module each time.
>> >> >>> _______________________________________________
>> >> >>> hibernate-dev mailing list
>> >> >>> hibernate-dev at lists.jboss.org
>> >> >>> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>> >> > _______________________________________________
>> >> > hibernate-dev mailing list
>> >> > hibernate-dev at lists.jboss.org
>> >> > https://lists.jboss.org/mailman/listinfo/hibernate-dev
>> >
>> >
>> _______________________________________________
>> hibernate-dev mailing list
>> hibernate-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>>
>
>