You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hop.apache.org by Hans Van Akelyen <ha...@gmail.com> on 2021/01/08 14:14:22 UTC
Update file headers
Hi Team,
One of the issues with our previous release candidate was that we still had
multiple header formats.
I have created a draft PR to resolve this issue [1]. It also contains
further cleanup for the rat excludes.
To evaluate the RAT excludes I suggest using following command
mvn clean apache-rat:check -debug -N > rat.log
I would like that some of you do an extra evaluation of the headers present
in the repository.
In all Java files they should be streamlined to following format (except
for the files containing an EPL license)
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
other file types may use a different format but the content has to be the
same (depends on how comments are handled in the files)
If you find any issues, post them here or add them to the PR.
Cheers,
Hans
[1] https://github.com/apache/incubator-hop/pull/542
Re: Update file headers
Posted by fp...@apache.org.
Hi,
We can use both (RAT and license-maven-plugin), I usually use
license-maven-plugin to format automatically the header file and RAT to
validate.
regards,
François
fpapon@apache.org
Le 11/01/2021 à 16:22, Hans Van Akelyen a écrit :
> Hi François,
>
> We have RAT enabled on our PR builds, but it has a couple of shortcomings
> in some cases.
> If you stack multiple licenses for example it will not fail.
>
> Maybe taking a look at the license maven plugin isn't a bad idea.
>
> Cheers,
> Hans
>
> On Mon, Jan 11, 2021 at 4:15 PM <fp...@apache.org> wrote:
>
>> Hi,
>>
>> You can use the license-maven-plugin to check and auto-format/add the
>> header in the files with some rules based on the different format file.
>>
>> https://github.com/mycila/license-maven-plugin
>> <https://github.com/mycila/license-maven-plugin>
>>
>> Here an example:
>>
>>
>> https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196
>> <
>> https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196
>> I can help and propose a PR if needed.
>>
>> regards,
>>
>> François
>> fpapon@apache.org
>>
>> Le 10/01/2021 à 12:56, Maximilian Michels a écrit :
>>> Thanks Hans! I like that we are now enforcing the ASF license header,
>>> except for the exclusions.
>>>
>>> -Max
>>>
>>> On 08.01.21 15:57, Matt Casters wrote:
>>>> Thanks again for the hard work Hans!
>>>>
>>>> I took the liberty of explaining new developers how to set up a
>>>> copyright
>>>> profile in Idea so that it gets added automatically where possible:
>>>>
>>>> https://github.com/apache/incubator-hop-docs/pull/34
>>>>
>>>> Cheers,
>>>> Matt
>>>>
>>>> On Fri, Jan 8, 2021 at 3:14 PM Hans Van Akelyen
>>>> <ha...@gmail.com>
>>>> wrote:
>>>>
>>>>> Hi Team,
>>>>>
>>>>> One of the issues with our previous release candidate was that we
>>>>> still had
>>>>> multiple header formats.
>>>>> I have created a draft PR to resolve this issue [1]. It also contains
>>>>> further cleanup for the rat excludes.
>>>>>
>>>>> To evaluate the RAT excludes I suggest using following command
>>>>> mvn clean apache-rat:check -debug -N > rat.log
>>>>>
>>>>> I would like that some of you do an extra evaluation of the headers
>>>>> present
>>>>> in the repository.
>>>>>
>>>>> In all Java files they should be streamlined to following format
>>>>> (except
>>>>> for the files containing an EPL license)
>>>>>
>>>>> /*
>>>>> * Licensed to the Apache Software Foundation (ASF) under one or more
>>>>> * contributor license agreements. See the NOTICE file distributed
>>>>> with
>>>>> * this work for additional information regarding copyright ownership.
>>>>> * The ASF licenses this file to You under the Apache License,
>>>>> Version 2.0
>>>>> * (the "License"); you may not use this file except in compliance
>>>>> with
>>>>> * the License. You may obtain a copy of the License at
>>>>> *
>>>>> * http://www.apache.org/licenses/LICENSE-2.0
>>>>> *
>>>>> * Unless required by applicable law or agreed to in writing, software
>>>>> * distributed under the License is distributed on an "AS IS" BASIS,
>>>>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>>>>> implied.
>>>>> * See the License for the specific language governing permissions and
>>>>> * limitations under the License.
>>>>> */
>>>>>
>>>>> other file types may use a different format but the content has to
>>>>> be the
>>>>> same (depends on how comments are handled in the files)
>>>>>
>>>>> If you find any issues, post them here or add them to the PR.
>>>>>
>>>>> Cheers,
>>>>> Hans
>>>>>
>>>>> [1] https://github.com/apache/incubator-hop/pull/542
>>>>>
>>>>
Re: Update file headers
Posted by Hans Van Akelyen <ha...@gmail.com>.
Hi François,
We have RAT enabled on our PR builds, but it has a couple of shortcomings
in some cases.
If you stack multiple licenses for example it will not fail.
Maybe taking a look at the license maven plugin isn't a bad idea.
Cheers,
Hans
On Mon, Jan 11, 2021 at 4:15 PM <fp...@apache.org> wrote:
> Hi,
>
> You can use the license-maven-plugin to check and auto-format/add the
> header in the files with some rules based on the different format file.
>
> https://github.com/mycila/license-maven-plugin
> <https://github.com/mycila/license-maven-plugin>
>
> Here an example:
>
>
> https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196
> <
> https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196
> >
>
> I can help and propose a PR if needed.
>
> regards,
>
> François
> fpapon@apache.org
>
> Le 10/01/2021 à 12:56, Maximilian Michels a écrit :
> > Thanks Hans! I like that we are now enforcing the ASF license header,
> > except for the exclusions.
> >
> > -Max
> >
> > On 08.01.21 15:57, Matt Casters wrote:
> >> Thanks again for the hard work Hans!
> >>
> >> I took the liberty of explaining new developers how to set up a
> >> copyright
> >> profile in Idea so that it gets added automatically where possible:
> >>
> >> https://github.com/apache/incubator-hop-docs/pull/34
> >>
> >> Cheers,
> >> Matt
> >>
> >> On Fri, Jan 8, 2021 at 3:14 PM Hans Van Akelyen
> >> <ha...@gmail.com>
> >> wrote:
> >>
> >>> Hi Team,
> >>>
> >>> One of the issues with our previous release candidate was that we
> >>> still had
> >>> multiple header formats.
> >>> I have created a draft PR to resolve this issue [1]. It also contains
> >>> further cleanup for the rat excludes.
> >>>
> >>> To evaluate the RAT excludes I suggest using following command
> >>> mvn clean apache-rat:check -debug -N > rat.log
> >>>
> >>> I would like that some of you do an extra evaluation of the headers
> >>> present
> >>> in the repository.
> >>>
> >>> In all Java files they should be streamlined to following format
> >>> (except
> >>> for the files containing an EPL license)
> >>>
> >>> /*
> >>> * Licensed to the Apache Software Foundation (ASF) under one or more
> >>> * contributor license agreements. See the NOTICE file distributed
> >>> with
> >>> * this work for additional information regarding copyright ownership.
> >>> * The ASF licenses this file to You under the Apache License,
> >>> Version 2.0
> >>> * (the "License"); you may not use this file except in compliance
> >>> with
> >>> * the License. You may obtain a copy of the License at
> >>> *
> >>> * http://www.apache.org/licenses/LICENSE-2.0
> >>> *
> >>> * Unless required by applicable law or agreed to in writing, software
> >>> * distributed under the License is distributed on an "AS IS" BASIS,
> >>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
> >>> implied.
> >>> * See the License for the specific language governing permissions and
> >>> * limitations under the License.
> >>> */
> >>>
> >>> other file types may use a different format but the content has to
> >>> be the
> >>> same (depends on how comments are handled in the files)
> >>>
> >>> If you find any issues, post them here or add them to the PR.
> >>>
> >>> Cheers,
> >>> Hans
> >>>
> >>> [1] https://github.com/apache/incubator-hop/pull/542
> >>>
> >>
> >>
>
Re: Update file headers
Posted by fp...@apache.org.
Hi,
You can use the license-maven-plugin to check and auto-format/add the
header in the files with some rules based on the different format file.
https://github.com/mycila/license-maven-plugin
<https://github.com/mycila/license-maven-plugin>
Here an example:
https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196
<https://github.com/yupiik/yupiik-logging/blob/3ec4444ca897cc8e215e02086303c4ecfc44d20f/pom.xml#L196>
I can help and propose a PR if needed.
regards,
François
fpapon@apache.org
Le 10/01/2021 à 12:56, Maximilian Michels a écrit :
> Thanks Hans! I like that we are now enforcing the ASF license header,
> except for the exclusions.
>
> -Max
>
> On 08.01.21 15:57, Matt Casters wrote:
>> Thanks again for the hard work Hans!
>>
>> I took the liberty of explaining new developers how to set up a
>> copyright
>> profile in Idea so that it gets added automatically where possible:
>>
>> https://github.com/apache/incubator-hop-docs/pull/34
>>
>> Cheers,
>> Matt
>>
>> On Fri, Jan 8, 2021 at 3:14 PM Hans Van Akelyen
>> <ha...@gmail.com>
>> wrote:
>>
>>> Hi Team,
>>>
>>> One of the issues with our previous release candidate was that we
>>> still had
>>> multiple header formats.
>>> I have created a draft PR to resolve this issue [1]. It also contains
>>> further cleanup for the rat excludes.
>>>
>>> To evaluate the RAT excludes I suggest using following command
>>> mvn clean apache-rat:check -debug -N > rat.log
>>>
>>> I would like that some of you do an extra evaluation of the headers
>>> present
>>> in the repository.
>>>
>>> In all Java files they should be streamlined to following format
>>> (except
>>> for the files containing an EPL license)
>>>
>>> /*
>>> * Licensed to the Apache Software Foundation (ASF) under one or more
>>> * contributor license agreements. See the NOTICE file distributed
>>> with
>>> * this work for additional information regarding copyright ownership.
>>> * The ASF licenses this file to You under the Apache License,
>>> Version 2.0
>>> * (the "License"); you may not use this file except in compliance
>>> with
>>> * the License. You may obtain a copy of the License at
>>> *
>>> * http://www.apache.org/licenses/LICENSE-2.0
>>> *
>>> * Unless required by applicable law or agreed to in writing, software
>>> * distributed under the License is distributed on an "AS IS" BASIS,
>>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
>>> implied.
>>> * See the License for the specific language governing permissions and
>>> * limitations under the License.
>>> */
>>>
>>> other file types may use a different format but the content has to
>>> be the
>>> same (depends on how comments are handled in the files)
>>>
>>> If you find any issues, post them here or add them to the PR.
>>>
>>> Cheers,
>>> Hans
>>>
>>> [1] https://github.com/apache/incubator-hop/pull/542
>>>
>>
>>
Re: Update file headers
Posted by Maximilian Michels <mx...@apache.org>.
Thanks Hans! I like that we are now enforcing the ASF license header,
except for the exclusions.
-Max
On 08.01.21 15:57, Matt Casters wrote:
> Thanks again for the hard work Hans!
>
> I took the liberty of explaining new developers how to set up a copyright
> profile in Idea so that it gets added automatically where possible:
>
> https://github.com/apache/incubator-hop-docs/pull/34
>
> Cheers,
> Matt
>
> On Fri, Jan 8, 2021 at 3:14 PM Hans Van Akelyen <ha...@gmail.com>
> wrote:
>
>> Hi Team,
>>
>> One of the issues with our previous release candidate was that we still had
>> multiple header formats.
>> I have created a draft PR to resolve this issue [1]. It also contains
>> further cleanup for the rat excludes.
>>
>> To evaluate the RAT excludes I suggest using following command
>> mvn clean apache-rat:check -debug -N > rat.log
>>
>> I would like that some of you do an extra evaluation of the headers present
>> in the repository.
>>
>> In all Java files they should be streamlined to following format (except
>> for the files containing an EPL license)
>>
>> /*
>> * Licensed to the Apache Software Foundation (ASF) under one or more
>> * contributor license agreements. See the NOTICE file distributed with
>> * this work for additional information regarding copyright ownership.
>> * The ASF licenses this file to You under the Apache License, Version 2.0
>> * (the "License"); you may not use this file except in compliance with
>> * the License. You may obtain a copy of the License at
>> *
>> * http://www.apache.org/licenses/LICENSE-2.0
>> *
>> * Unless required by applicable law or agreed to in writing, software
>> * distributed under the License is distributed on an "AS IS" BASIS,
>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>> * See the License for the specific language governing permissions and
>> * limitations under the License.
>> */
>>
>> other file types may use a different format but the content has to be the
>> same (depends on how comments are handled in the files)
>>
>> If you find any issues, post them here or add them to the PR.
>>
>> Cheers,
>> Hans
>>
>> [1] https://github.com/apache/incubator-hop/pull/542
>>
>
>
Re: Update file headers
Posted by Matt Casters <ma...@neo4j.com.INVALID>.
Thanks again for the hard work Hans!
I took the liberty of explaining new developers how to set up a copyright
profile in Idea so that it gets added automatically where possible:
https://github.com/apache/incubator-hop-docs/pull/34
Cheers,
Matt
On Fri, Jan 8, 2021 at 3:14 PM Hans Van Akelyen <ha...@gmail.com>
wrote:
> Hi Team,
>
> One of the issues with our previous release candidate was that we still had
> multiple header formats.
> I have created a draft PR to resolve this issue [1]. It also contains
> further cleanup for the rat excludes.
>
> To evaluate the RAT excludes I suggest using following command
> mvn clean apache-rat:check -debug -N > rat.log
>
> I would like that some of you do an extra evaluation of the headers present
> in the repository.
>
> In all Java files they should be streamlined to following format (except
> for the files containing an EPL license)
>
> /*
> * Licensed to the Apache Software Foundation (ASF) under one or more
> * contributor license agreements. See the NOTICE file distributed with
> * this work for additional information regarding copyright ownership.
> * The ASF licenses this file to You under the Apache License, Version 2.0
> * (the "License"); you may not use this file except in compliance with
> * the License. You may obtain a copy of the License at
> *
> * http://www.apache.org/licenses/LICENSE-2.0
> *
> * Unless required by applicable law or agreed to in writing, software
> * distributed under the License is distributed on an "AS IS" BASIS,
> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> * See the License for the specific language governing permissions and
> * limitations under the License.
> */
>
> other file types may use a different format but the content has to be the
> same (depends on how comments are handled in the files)
>
> If you find any issues, post them here or add them to the PR.
>
> Cheers,
> Hans
>
> [1] https://github.com/apache/incubator-hop/pull/542
>
--
Neo4j Chief Solutions Architect
*✉ *matt.casters@neo4j.com
☎ +32486972937