You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@drill.apache.org by Timothy Farkas <tf...@mapr.com> on 2018/04/17 20:41:24 UTC
License Header FYI
Hi All,
Recently the license formatting checks have become stricter and all the license headers have been reformatted. The main benefit from this is that it is no longer allowed to have license headers in java doc comments. This will help keep our javadocs clean when we publish them. By default license checks are disabled, but they are enabled for Travis. To manually enable license checks locally add -Drat.skip-false and -Dlicense.skip=false args to your maven command. Also to automatically add license headers to your new files do mvn license:format
For the next couple days please manually check the license headers for your PRs. Also if you regenerate classes in drill/protocol please manually run mvn license:format to add the license headers. This is necessary because my last change broke Travis and auto formatting of licenses for generated classes, but this will be fixed after https://github.com/apache/drill/pull/1215 is merged.
Thanks,
Tim
Re: License Header FYI
Posted by Vlad Rozov <vr...@apache.org>.
My 2 cents:
License headers are mandatory only for the Apache release, so it is
never too late to add the license header if it is missing before a
release goes out.
I'd suggest to start leveraging Travis and Jenkins more for routine
tasks such as license header check and unit testing. Both CI tools build
using freshly created repository compared to a local repository that may
be polluted with extra files that don't have necessary license headers
or local changes. That causes local build to fail, so I disable
apache-rat anyway and it would not save me from committing files without
the license header.
Yes, the overhead is not big compared to the total build time, but even
if it is 30 seconds or less, multiplied by # of developers, # of builds
each day and by number of days in a year, it is quite significant.
Thank you,
Vlad
On 4/19/18 13:01, Parth Chandra wrote:
> Yes, but Travis was disabled for so long that some of us don't pay
> attention to it. And the overhead of a dev build is not that great,
> especially since almost all developers use an IDE which does incremental
> builds anyway.
> In the past, I have added new files and forgotten to add the license
> headers (which are mandatory) and have been saved by the rat checks,
> annoying though they are.
>
> On Thu, Apr 19, 2018 at 6:26 AM, Vlad Rozov <vr...@apache.org> wrote:
>
>> Enabling apache-rat by default triggers the unnecessary check for every
>> development build. Travis-CI already have it enabled and will fail the
>> build if the header is missing. It can be also run as a standalone task
>> prior to a push to a remote.
>>
>> Thank you,
>>
>> Vlad
>>
>>
>> On 4/18/18 23:52, Arina Yelchiyeva wrote:
>>
>>> I also agree that these checks should be enabled by default.
>>>
>>> On Thu, Apr 19, 2018 at 2:07 AM, Timothy Farkas <tf...@mapr.com> wrote:
>>>
>>> Looks like I gave the wrong command. Just tested this incantation and it
>>>> worked on master.
>>>>
>>>> mvn license:format -Dlicense.skip=false
>>>>
>>>> When I removed the license header on Drillbit.java it was added back
>>>> again.
>>>>
>>>>
>>>>
>>>> ________________________________
>>>> From: Parth Chandra <pa...@apache.org>
>>>> Sent: Wednesday, April 18, 2018 3:54:36 PM
>>>> To: dev
>>>> Subject: Re: License Header FYI
>>>>
>>>> mvn license:format (not man license:format ) seems to not do anything.
>>>>
>>>> On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org>
>>>> wrote:
>>>>
>>>> man license:format does not seem t be doing anything.
>>>>> Also, IMO it would be a good idea to enable rat checks by default. At
>>>>> the
>>>>> very least we need to make sure that the license headers are there
>>>>> before
>>>>> we check anything in.
>>>>>
>>>>> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com>
>>>>>
>>>> wrote:
>>>>
>>>>> Hi All,
>>>>>> Recently the license formatting checks have become stricter and all the
>>>>>> license headers have been reformatted. The main benefit from this is
>>>>>>
>>>>> that
>>>>> it is no longer allowed to have license headers in java doc comments.
>>>>> This
>>>>> will help keep our javadocs clean when we publish them. By default
>>>>> license
>>>>> checks are disabled, but they are enabled for Travis. To manually enable
>>>>>> license checks locally add -Drat.skip-false and -Dlicense.skip=false
>>>>>>
>>>>> args
>>>>> to your maven command. Also to automatically add license headers to your
>>>>>> new files do mvn license:format
>>>>>>
>>>>>> For the next couple days please manually check the license headers for
>>>>>> your PRs. Also if you regenerate classes in drill/protocol please
>>>>>>
>>>>> manually
>>>>> run mvn license:format to add the license headers. This is necessary
>>>>>> because my last change broke Travis and auto formatting of licenses for
>>>>>> generated classes, but this will be fixed after
>>>>>> https://urldefense.proofpoint.com/v2/url?u=https-3A__github.
>>>>>>
>>>>> com_apache_drill_pull_1215&d=DwIBaQ&c=cskdkSMqhcnjZxdQVpwTXg&r=
>>>> 4eQVr8zB8ZBff-yxTimdOQ&m=vnpyMg6WPxgAajLqWgn0FRdxqUb1IQJObkIOKqh-MOE&s=
>>>> guKPyopeVkavMDrswmmScd2mXR_ZQvdwjG2oyy02M9U&e= is merged.
>>>>
>>>>> Thanks,
>>>>>> Tim
>>>>>>
>>>>>>
Re: License Header FYI
Posted by Parth Chandra <pa...@apache.org>.
Yes, but Travis was disabled for so long that some of us don't pay
attention to it. And the overhead of a dev build is not that great,
especially since almost all developers use an IDE which does incremental
builds anyway.
In the past, I have added new files and forgotten to add the license
headers (which are mandatory) and have been saved by the rat checks,
annoying though they are.
On Thu, Apr 19, 2018 at 6:26 AM, Vlad Rozov <vr...@apache.org> wrote:
> Enabling apache-rat by default triggers the unnecessary check for every
> development build. Travis-CI already have it enabled and will fail the
> build if the header is missing. It can be also run as a standalone task
> prior to a push to a remote.
>
> Thank you,
>
> Vlad
>
>
> On 4/18/18 23:52, Arina Yelchiyeva wrote:
>
>> I also agree that these checks should be enabled by default.
>>
>> On Thu, Apr 19, 2018 at 2:07 AM, Timothy Farkas <tf...@mapr.com> wrote:
>>
>> Looks like I gave the wrong command. Just tested this incantation and it
>>> worked on master.
>>>
>>> mvn license:format -Dlicense.skip=false
>>>
>>> When I removed the license header on Drillbit.java it was added back
>>> again.
>>>
>>>
>>>
>>> ________________________________
>>> From: Parth Chandra <pa...@apache.org>
>>> Sent: Wednesday, April 18, 2018 3:54:36 PM
>>> To: dev
>>> Subject: Re: License Header FYI
>>>
>>> mvn license:format (not man license:format ) seems to not do anything.
>>>
>>> On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org>
>>> wrote:
>>>
>>> man license:format does not seem t be doing anything.
>>>> Also, IMO it would be a good idea to enable rat checks by default. At
>>>> the
>>>> very least we need to make sure that the license headers are there
>>>> before
>>>> we check anything in.
>>>>
>>>> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com>
>>>>
>>> wrote:
>>>
>>>> Hi All,
>>>>>
>>>>> Recently the license formatting checks have become stricter and all the
>>>>> license headers have been reformatted. The main benefit from this is
>>>>>
>>>> that
>>>
>>>> it is no longer allowed to have license headers in java doc comments.
>>>>>
>>>> This
>>>
>>>> will help keep our javadocs clean when we publish them. By default
>>>>>
>>>> license
>>>
>>>> checks are disabled, but they are enabled for Travis. To manually enable
>>>>> license checks locally add -Drat.skip-false and -Dlicense.skip=false
>>>>>
>>>> args
>>>
>>>> to your maven command. Also to automatically add license headers to your
>>>>> new files do mvn license:format
>>>>>
>>>>> For the next couple days please manually check the license headers for
>>>>> your PRs. Also if you regenerate classes in drill/protocol please
>>>>>
>>>> manually
>>>
>>>> run mvn license:format to add the license headers. This is necessary
>>>>> because my last change broke Travis and auto formatting of licenses for
>>>>> generated classes, but this will be fixed after
>>>>> https://urldefense.proofpoint.com/v2/url?u=https-3A__github.
>>>>>
>>>> com_apache_drill_pull_1215&d=DwIBaQ&c=cskdkSMqhcnjZxdQVpwTXg&r=
>>> 4eQVr8zB8ZBff-yxTimdOQ&m=vnpyMg6WPxgAajLqWgn0FRdxqUb1IQJObkIOKqh-MOE&s=
>>> guKPyopeVkavMDrswmmScd2mXR_ZQvdwjG2oyy02M9U&e= is merged.
>>>
>>>> Thanks,
>>>>> Tim
>>>>>
>>>>>
>>>>
>
Re: License Header FYI
Posted by Vlad Rozov <vr...@apache.org>.
Enabling apache-rat by default triggers the unnecessary check for every
development build. Travis-CI already have it enabled and will fail the
build if the header is missing. It can be also run as a standalone task
prior to a push to a remote.
Thank you,
Vlad
On 4/18/18 23:52, Arina Yelchiyeva wrote:
> I also agree that these checks should be enabled by default.
>
> On Thu, Apr 19, 2018 at 2:07 AM, Timothy Farkas <tf...@mapr.com> wrote:
>
>> Looks like I gave the wrong command. Just tested this incantation and it
>> worked on master.
>>
>> mvn license:format -Dlicense.skip=false
>>
>> When I removed the license header on Drillbit.java it was added back again.
>>
>>
>>
>> ________________________________
>> From: Parth Chandra <pa...@apache.org>
>> Sent: Wednesday, April 18, 2018 3:54:36 PM
>> To: dev
>> Subject: Re: License Header FYI
>>
>> mvn license:format (not man license:format ) seems to not do anything.
>>
>> On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org> wrote:
>>
>>> man license:format does not seem t be doing anything.
>>> Also, IMO it would be a good idea to enable rat checks by default. At the
>>> very least we need to make sure that the license headers are there before
>>> we check anything in.
>>>
>>> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com>
>> wrote:
>>>> Hi All,
>>>>
>>>> Recently the license formatting checks have become stricter and all the
>>>> license headers have been reformatted. The main benefit from this is
>> that
>>>> it is no longer allowed to have license headers in java doc comments.
>> This
>>>> will help keep our javadocs clean when we publish them. By default
>> license
>>>> checks are disabled, but they are enabled for Travis. To manually enable
>>>> license checks locally add -Drat.skip-false and -Dlicense.skip=false
>> args
>>>> to your maven command. Also to automatically add license headers to your
>>>> new files do mvn license:format
>>>>
>>>> For the next couple days please manually check the license headers for
>>>> your PRs. Also if you regenerate classes in drill/protocol please
>> manually
>>>> run mvn license:format to add the license headers. This is necessary
>>>> because my last change broke Travis and auto formatting of licenses for
>>>> generated classes, but this will be fixed after
>>>> https://urldefense.proofpoint.com/v2/url?u=https-3A__github.
>> com_apache_drill_pull_1215&d=DwIBaQ&c=cskdkSMqhcnjZxdQVpwTXg&r=
>> 4eQVr8zB8ZBff-yxTimdOQ&m=vnpyMg6WPxgAajLqWgn0FRdxqUb1IQJObkIOKqh-MOE&s=
>> guKPyopeVkavMDrswmmScd2mXR_ZQvdwjG2oyy02M9U&e= is merged.
>>>> Thanks,
>>>> Tim
>>>>
>>>
Re: License Header FYI
Posted by Arina Yelchiyeva <ar...@gmail.com>.
I also agree that these checks should be enabled by default.
On Thu, Apr 19, 2018 at 2:07 AM, Timothy Farkas <tf...@mapr.com> wrote:
> Looks like I gave the wrong command. Just tested this incantation and it
> worked on master.
>
> mvn license:format -Dlicense.skip=false
>
> When I removed the license header on Drillbit.java it was added back again.
>
>
>
> ________________________________
> From: Parth Chandra <pa...@apache.org>
> Sent: Wednesday, April 18, 2018 3:54:36 PM
> To: dev
> Subject: Re: License Header FYI
>
> mvn license:format (not man license:format ) seems to not do anything.
>
> On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org> wrote:
>
> > man license:format does not seem t be doing anything.
> > Also, IMO it would be a good idea to enable rat checks by default. At the
> > very least we need to make sure that the license headers are there before
> > we check anything in.
> >
> > On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com>
> wrote:
> >
> >> Hi All,
> >>
> >> Recently the license formatting checks have become stricter and all the
> >> license headers have been reformatted. The main benefit from this is
> that
> >> it is no longer allowed to have license headers in java doc comments.
> This
> >> will help keep our javadocs clean when we publish them. By default
> license
> >> checks are disabled, but they are enabled for Travis. To manually enable
> >> license checks locally add -Drat.skip-false and -Dlicense.skip=false
> args
> >> to your maven command. Also to automatically add license headers to your
> >> new files do mvn license:format
> >>
> >> For the next couple days please manually check the license headers for
> >> your PRs. Also if you regenerate classes in drill/protocol please
> manually
> >> run mvn license:format to add the license headers. This is necessary
> >> because my last change broke Travis and auto formatting of licenses for
> >> generated classes, but this will be fixed after
> >> https://urldefense.proofpoint.com/v2/url?u=https-3A__github.
> com_apache_drill_pull_1215&d=DwIBaQ&c=cskdkSMqhcnjZxdQVpwTXg&r=
> 4eQVr8zB8ZBff-yxTimdOQ&m=vnpyMg6WPxgAajLqWgn0FRdxqUb1IQJObkIOKqh-MOE&s=
> guKPyopeVkavMDrswmmScd2mXR_ZQvdwjG2oyy02M9U&e= is merged.
> >>
> >> Thanks,
> >> Tim
> >>
> >
> >
>
Re: License Header FYI
Posted by Timothy Farkas <tf...@mapr.com>.
Looks like I gave the wrong command. Just tested this incantation and it worked on master.
mvn license:format -Dlicense.skip=false
When I removed the license header on Drillbit.java it was added back again.
________________________________
From: Parth Chandra <pa...@apache.org>
Sent: Wednesday, April 18, 2018 3:54:36 PM
To: dev
Subject: Re: License Header FYI
mvn license:format (not man license:format ) seems to not do anything.
On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org> wrote:
> man license:format does not seem t be doing anything.
> Also, IMO it would be a good idea to enable rat checks by default. At the
> very least we need to make sure that the license headers are there before
> we check anything in.
>
> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com> wrote:
>
>> Hi All,
>>
>> Recently the license formatting checks have become stricter and all the
>> license headers have been reformatted. The main benefit from this is that
>> it is no longer allowed to have license headers in java doc comments. This
>> will help keep our javadocs clean when we publish them. By default license
>> checks are disabled, but they are enabled for Travis. To manually enable
>> license checks locally add -Drat.skip-false and -Dlicense.skip=false args
>> to your maven command. Also to automatically add license headers to your
>> new files do mvn license:format
>>
>> For the next couple days please manually check the license headers for
>> your PRs. Also if you regenerate classes in drill/protocol please manually
>> run mvn license:format to add the license headers. This is necessary
>> because my last change broke Travis and auto formatting of licenses for
>> generated classes, but this will be fixed after
>> https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_apache_drill_pull_1215&d=DwIBaQ&c=cskdkSMqhcnjZxdQVpwTXg&r=4eQVr8zB8ZBff-yxTimdOQ&m=vnpyMg6WPxgAajLqWgn0FRdxqUb1IQJObkIOKqh-MOE&s=guKPyopeVkavMDrswmmScd2mXR_ZQvdwjG2oyy02M9U&e= is merged.
>>
>> Thanks,
>> Tim
>>
>
>
Re: License Header FYI
Posted by Parth Chandra <pa...@apache.org>.
mvn license:format (not man license:format ) seems to not do anything.
On Wed, Apr 18, 2018 at 3:53 PM, Parth Chandra <pa...@apache.org> wrote:
> man license:format does not seem t be doing anything.
> Also, IMO it would be a good idea to enable rat checks by default. At the
> very least we need to make sure that the license headers are there before
> we check anything in.
>
> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com> wrote:
>
>> Hi All,
>>
>> Recently the license formatting checks have become stricter and all the
>> license headers have been reformatted. The main benefit from this is that
>> it is no longer allowed to have license headers in java doc comments. This
>> will help keep our javadocs clean when we publish them. By default license
>> checks are disabled, but they are enabled for Travis. To manually enable
>> license checks locally add -Drat.skip-false and -Dlicense.skip=false args
>> to your maven command. Also to automatically add license headers to your
>> new files do mvn license:format
>>
>> For the next couple days please manually check the license headers for
>> your PRs. Also if you regenerate classes in drill/protocol please manually
>> run mvn license:format to add the license headers. This is necessary
>> because my last change broke Travis and auto formatting of licenses for
>> generated classes, but this will be fixed after
>> https://github.com/apache/drill/pull/1215 is merged.
>>
>> Thanks,
>> Tim
>>
>
>
Re: License Header FYI
Posted by Parth Chandra <pa...@apache.org>.
man license:format does not seem t be doing anything.
Also, IMO it would be a good idea to enable rat checks by default. At the
very least we need to make sure that the license headers are there before
we check anything in.
On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com> wrote:
> Hi All,
>
> Recently the license formatting checks have become stricter and all the
> license headers have been reformatted. The main benefit from this is that
> it is no longer allowed to have license headers in java doc comments. This
> will help keep our javadocs clean when we publish them. By default license
> checks are disabled, but they are enabled for Travis. To manually enable
> license checks locally add -Drat.skip-false and -Dlicense.skip=false args
> to your maven command. Also to automatically add license headers to your
> new files do mvn license:format
>
> For the next couple days please manually check the license headers for
> your PRs. Also if you regenerate classes in drill/protocol please manually
> run mvn license:format to add the license headers. This is necessary
> because my last change broke Travis and auto formatting of licenses for
> generated classes, but this will be fixed after https://github.com/apache/
> drill/pull/1215 is merged.
>
> Thanks,
> Tim
>
Re: License Header FYI
Posted by Arina Yelchiyeva <ar...@gmail.com>.
Yes, until https://github.com/apache/drill/pull/1215 is merged in.
On Wed, Apr 18, 2018 at 8:51 AM, Abhishek Girish <ag...@apache.org> wrote:
> Hey Tim,
>
> I tried building master and encountered an error:
>
> mvn clean install -U -Pmapr -Drat.skip=false -Dlicense.skip=false
>
> ...
>
> [ERROR] Failed to execute goal com.mycila:license-maven-plugin:3.0:check
> > (default) on project drill-root: Some files do not have the expected
> > license header -> [Help 1]
>
>
> Is that expected?
>
> On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com> wrote:
>
> > Hi All,
> >
> > Recently the license formatting checks have become stricter and all the
> > license headers have been reformatted. The main benefit from this is that
> > it is no longer allowed to have license headers in java doc comments.
> This
> > will help keep our javadocs clean when we publish them. By default
> license
> > checks are disabled, but they are enabled for Travis. To manually enable
> > license checks locally add -Drat.skip-false and -Dlicense.skip=false args
> > to your maven command. Also to automatically add license headers to your
> > new files do mvn license:format
> >
> > For the next couple days please manually check the license headers for
> > your PRs. Also if you regenerate classes in drill/protocol please
> manually
> > run mvn license:format to add the license headers. This is necessary
> > because my last change broke Travis and auto formatting of licenses for
> > generated classes, but this will be fixed after
> https://github.com/apache/
> > drill/pull/1215 is merged.
> >
> > Thanks,
> > Tim
> >
>
Re: License Header FYI
Posted by Abhishek Girish <ag...@apache.org>.
Hey Tim,
I tried building master and encountered an error:
mvn clean install -U -Pmapr -Drat.skip=false -Dlicense.skip=false
...
[ERROR] Failed to execute goal com.mycila:license-maven-plugin:3.0:check
> (default) on project drill-root: Some files do not have the expected
> license header -> [Help 1]
Is that expected?
On Tue, Apr 17, 2018 at 1:41 PM, Timothy Farkas <tf...@mapr.com> wrote:
> Hi All,
>
> Recently the license formatting checks have become stricter and all the
> license headers have been reformatted. The main benefit from this is that
> it is no longer allowed to have license headers in java doc comments. This
> will help keep our javadocs clean when we publish them. By default license
> checks are disabled, but they are enabled for Travis. To manually enable
> license checks locally add -Drat.skip-false and -Dlicense.skip=false args
> to your maven command. Also to automatically add license headers to your
> new files do mvn license:format
>
> For the next couple days please manually check the license headers for
> your PRs. Also if you regenerate classes in drill/protocol please manually
> run mvn license:format to add the license headers. This is necessary
> because my last change broke Travis and auto formatting of licenses for
> generated classes, but this will be fixed after https://github.com/apache/
> drill/pull/1215 is merged.
>
> Thanks,
> Tim
>