You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@taverna.apache.org by Stian Soiland-Reyes <st...@apache.org> on 2015/02/10 17:34:40 UTC
NOTICE files in multi-module Maven projects
Not sure what is the best Maven way to do NOTICE file management when
we have many modules and are going to release JARs in Maven Central. I
would prefer not having to do too much copy and pasting..
As the taverna-scufl2-schemas JAR in this case contains the actual XSD
as well, I've added:
https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
(Inspired by http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
which then is completed as a velocity template (to get the correct
project name and year), and generates this META-INF/NOTICE file in the
compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
> Apache Taverna Scufl 2 Schemas
> Copyright 2015 The Apache Software Foundation
>
> This product includes software developed at
> The Apache Software Foundation (http://www.apache.org/).
>
>
> # xml.xsd
>
> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
> document includes material copied from or derived from:
>
> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
> W3C Recommendation 26 November 2008
> http://www.w3.org/2001/xml.xsd
> http://www.w3.org/TR/xml/
.. but - the template META-INF/NOTICE.vm is also included in the JAR!
confusing.. but.. not "wrong" legally (it even has an Apache header to
keep RAT happy!).
Perhaps the Velocity template is taking this too far. If I add this
directly as META-INF/NOTICE it is included only once - but of course
"2015" will/may be out of date next year - but that's 10 greps a year
then. Is that really a problem?
Another question - how are NOTICE files from sub-modules meant to be
aggregated/combined in the source release of the taverna-language
project
(and in the command line/workbench binary releases that will include this JAR):
I tried building taverna-language now with the above, using:
mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
and in target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
I get an autogenerated NOTICE file that just says:
Apache Taverna Language APIs (Scufl2, Databundle)
Copyright 2015 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
To find that W3C notice you have to hunt around:
stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
find . -name '*NOTICE*'
./NOTICE
./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
Somehow I feel the mentors would not see this as job done..
Would anyone have time to check around if there is some help from
Maven plugins here (see other multi-module Apache projects), or if we
are just going to have to do a copy-paste job and hope we don't get it
wrong?
On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org> wrote:
> I have added license headers to all files in taverna-scufl2-schemas -
> all but one were ours.
>
> I guess we would get rid of the duplicates and use Maven dependencies..
>
>
> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
> also into LICENSE?
>
> http://www.w3.org/Consortium/Legal/2015/doc-license
>
> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>> Hello everybody,
>>
>> I have put the licenses on the xsd files that are definitely
>> Taverna-community-created.
>>
>> Alan
>>
>
> --
> Stian Soiland-Reyes
> Apache Taverna (incubating)
> http://orcid.org/0000-0001-9842-9718
--
Stian Soiland-Reyes
Apache Taverna (incubating)
http://orcid.org/0000-0001-9842-9718
Fwd: Re: NOTICE files in multi-module Maven projects
Posted by Marlon Pierce <ma...@iu.edu>.
Hi all--
Any recollection on how we did the NOTICE files?
Marlon
-------- Forwarded Message --------
Subject: Re: NOTICE files in multi-module Maven projects
Date: Tue, 10 Feb 2015 17:04:17 +0000
From: Stian Soiland-Reyes <st...@apache.org>
Reply-To: dev@taverna.incubator.apache.org
To: dev@taverna.incubator.apache.org
Thank you - there are just too many projects to look at!
Jena does this manually, which I've already gotten into trouble because of.. :-)
I had a look at Airavata.
Are these files all made by hand?
stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*'
./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
./modules/distribution/orchestrator-server/src/main/resources/NOTICE
./modules/distribution/xbaya-gui/src/main/resources/NOTICE
./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
./modules/distribution/api-server/src/main/resources/NOTICE
./modules/distribution/gfac-server/src/main/resources/NOTICE
./modules/distribution/client/java/src/main/resources/NOTICE
./modules/distribution/server/src/main/resources/NOTICE
./NOTICE
For example
https://github.com/apache/airavata/blob/master/modules/distribution/gfac-server/src/main/resources/NOTICE
looks pretty auto-generated to me. But perhaps it's just because it's
the same file mostly just copied around?
stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*' | xargs wc -l
163 ./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
4 ./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
163 ./modules/distribution/orchestrator-server/src/main/resources/NOTICE
162 ./modules/distribution/xbaya-gui/src/main/resources/NOTICE
162 ./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
163 ./modules/distribution/api-server/src/main/resources/NOTICE
163 ./modules/distribution/gfac-server/src/main/resources/NOTICE
163 ./modules/distribution/client/java/src/main/resources/NOTICE
163 ./modules/distribution/server/src/main/resources/NOTICE
6 ./NOTICE
That +/- 1 there is because:
stain@biggie-utopic:~/src/airavata$ diff
./modules/distribution/xbaya-gui/src/main/resources/NOTICE
./modules/distribution/orchestrator-server/src/main/resources/NOTICE
2c2
< Copyright 2013 The Apache Software Foundation
---
> Copyright 2014 The Apache Software Foundation
163c163
< ================================================================================================
\ No newline at end of file
---
> ================================================================================================
On 10 February 2015 at 16:36, Marlon Pierce <ma...@iu.edu> wrote:
> As always, you can steal from other projects. Did you look at Airavata?
> One of our mentors held our feet to the fire over this, so hopefully it will
> serve as a good model for you.
>
> Marlon
>
>
> On 2/10/15 11:34 AM, Stian Soiland-Reyes wrote:
>>
>> Not sure what is the best Maven way to do NOTICE file management when
>> we have many modules and are going to release JARs in Maven Central. I
>> would prefer not having to do too much copy and pasting..
>>
>>
>>
>> As the taverna-scufl2-schemas JAR in this case contains the actual XSD
>> as well, I've added:
>>
>>
>> https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>
>> (Inspired by
>> http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
>>
>>
>> which then is completed as a velocity template (to get the correct
>> project name and year), and generates this META-INF/NOTICE file in the
>> compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
>>
>>
>>> Apache Taverna Scufl 2 Schemas
>>> Copyright 2015 The Apache Software Foundation
>>>
>>> This product includes software developed at
>>> The Apache Software Foundation (http://www.apache.org/).
>>>
>>>
>>> # xml.xsd
>>>
>>> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
>>> document includes material copied from or derived from:
>>>
>>> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
>>> W3C Recommendation 26 November 2008
>>> http://www.w3.org/2001/xml.xsd
>>> http://www.w3.org/TR/xml/
>>
>>
>> .. but - the template META-INF/NOTICE.vm is also included in the JAR!
>> confusing.. but.. not "wrong" legally (it even has an Apache header to
>> keep RAT happy!).
>>
>> Perhaps the Velocity template is taking this too far. If I add this
>> directly as META-INF/NOTICE it is included only once - but of course
>> "2015" will/may be out of date next year - but that's 10 greps a year
>> then. Is that really a problem?
>>
>>
>>
>> Another question - how are NOTICE files from sub-modules meant to be
>> aggregated/combined in the source release of the taverna-language
>> project
>> (and in the command line/workbench binary releases that will include this
>> JAR):
>>
>>
>> I tried building taverna-language now with the above, using:
>>
>> mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
>>
>> and in
>> target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
>>
>> I get an autogenerated NOTICE file that just says:
>>
>> Apache Taverna Language APIs (Scufl2, Databundle)
>> Copyright 2015 The Apache Software Foundation
>>
>> This product includes software developed at
>> The Apache Software Foundation (http://www.apache.org/).
>>
>>
>>
>> To find that W3C notice you have to hunt around:
>>
>>
>> stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
>> find . -name '*NOTICE*'
>> ./NOTICE
>> ./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>
>>
>> Somehow I feel the mentors would not see this as job done..
>>
>>
>> Would anyone have time to check around if there is some help from
>> Maven plugins here (see other multi-module Apache projects), or if we
>> are just going to have to do a copy-paste job and hope we don't get it
>> wrong?
>>
>>
>>
>>
>> On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org>
>> wrote:
>>>
>>> I have added license headers to all files in taverna-scufl2-schemas -
>>> all but one were ours.
>>>
>>> I guess we would get rid of the duplicates and use Maven dependencies..
>>>
>>>
>>> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
>>> also into LICENSE?
>>>
>>> http://www.w3.org/Consortium/Legal/2015/doc-license
>>>
>>> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>>>>
>>>> Hello everybody,
>>>>
>>>> I have put the licenses on the xsd files that are definitely
>>>> Taverna-community-created.
>>>>
>>>> Alan
>>>>
>>> --
>>> Stian Soiland-Reyes
>>> Apache Taverna (incubating)
>>> http://orcid.org/0000-0001-9842-9718
>>
>>
>>
>
--
Stian Soiland-Reyes
Apache Taverna (incubating)
http://orcid.org/0000-0001-9842-9718
Re: NOTICE files in multi-module Maven projects
Posted by Stian Soiland-Reyes <st...@apache.org>.
I think we have the same problem in Taverna, as there will be several
binary packages (command line, workbench, server), but they will share
many artifacts.
So I guess the conclusion for us here is to just do them manually.. as
much as I dislike another manual thing to maintain :) As they build on
each-other then we can just have headings like "# Taverna Engine
notices" inside to make it easier to copy-paste that bit of the file
around on any updates.
I am not quite sure exactly where to store these files Maven-wise so
this works on the top-level pom project for each repository. Perhaps
we can't use the source distribution we inherit from Apache Parent and
have to do separate "apache-taverna-language" modules etc to make the
source artifacts?
On 11 February 2015 at 09:34, Andy Seaborne <an...@apache.org> wrote:
> On 10/02/15 17:04, Stian Soiland-Reyes wrote:
>>
>> Jena does this manually, which I've already gotten into trouble because
>> of..:-)
>
>
> Different parts of Jena need different NOTICE/LICENSE text.
>
> Each binary jar should have N&L specific to it's inputs.
>
> Uber jars are different again because of the rolling up of other systems.
>
> The source release contains things not in any jar (test files for example).
> W3C test files have LICENSE placed next to the relevant suites (and which is
> now how W3C distribute their own material for RDF and SPARQL because I got
> them to dual-license properly).
>
> Without commonality, automation is zero gain but the contents rarely change
> so maintenance is a once-a-year perl script for any copyright years.
>
> Andy
--
Stian Soiland-Reyes
Apache Taverna (incubating)
http://orcid.org/0000-0001-9842-9718
Re: NOTICE files in multi-module Maven projects
Posted by Andy Seaborne <an...@apache.org>.
On 10/02/15 17:04, Stian Soiland-Reyes wrote:
> Jena does this manually, which I've already gotten into trouble because of..:-)
Different parts of Jena need different NOTICE/LICENSE text.
Each binary jar should have N&L specific to it's inputs.
Uber jars are different again because of the rolling up of other systems.
The source release contains things not in any jar (test files for
example). W3C test files have LICENSE placed next to the relevant
suites (and which is now how W3C distribute their own material for RDF
and SPARQL because I got them to dual-license properly).
Without commonality, automation is zero gain but the contents rarely
change so maintenance is a once-a-year perl script for any copyright years.
Andy
Re: NOTICE files in multi-module Maven projects
Posted by Marlon Pierce <ma...@iu.edu>.
If I recall correctly, we made one blanket NOTICE and made sure it was
in the things that we distribute. Some possibly useful historical
emails for us on this topic:
http://markmail.org/message/lqwskupxl3b2oedn#query:+page:1+mid:kg6kyvi3myos44n4+state:results
and
http://markmail.org/message/lqwskupxl3b2oedn#query:+page:1+mid:lqwskupxl3b2oedn+state:results
Ate was the champion for the Apache Rave project, which you could also
look at as a model.
Marlon
On 2/10/15 12:04 PM, Stian Soiland-Reyes wrote:
> Thank you - there are just too many projects to look at!
>
> Jena does this manually, which I've already gotten into trouble because of.. :-)
>
>
> I had a look at Airavata.
>
> Are these files all made by hand?
>
> stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*'
> ./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
> ./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
> ./modules/distribution/orchestrator-server/src/main/resources/NOTICE
> ./modules/distribution/xbaya-gui/src/main/resources/NOTICE
> ./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
> ./modules/distribution/api-server/src/main/resources/NOTICE
> ./modules/distribution/gfac-server/src/main/resources/NOTICE
> ./modules/distribution/client/java/src/main/resources/NOTICE
> ./modules/distribution/server/src/main/resources/NOTICE
> ./NOTICE
>
> For example
> https://github.com/apache/airavata/blob/master/modules/distribution/gfac-server/src/main/resources/NOTICE
>
> looks pretty auto-generated to me. But perhaps it's just because it's
> the same file mostly just copied around?
>
> stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*' | xargs wc -l
> 163 ./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
> 4 ./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
> 163 ./modules/distribution/orchestrator-server/src/main/resources/NOTICE
> 162 ./modules/distribution/xbaya-gui/src/main/resources/NOTICE
> 162 ./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
> 163 ./modules/distribution/api-server/src/main/resources/NOTICE
> 163 ./modules/distribution/gfac-server/src/main/resources/NOTICE
> 163 ./modules/distribution/client/java/src/main/resources/NOTICE
> 163 ./modules/distribution/server/src/main/resources/NOTICE
> 6 ./NOTICE
>
>
> That +/- 1 there is because:
>
> stain@biggie-utopic:~/src/airavata$ diff
> ./modules/distribution/xbaya-gui/src/main/resources/NOTICE
> ./modules/distribution/orchestrator-server/src/main/resources/NOTICE
> 2c2
> < Copyright 2013 The Apache Software Foundation
> ---
>> Copyright 2014 The Apache Software Foundation
> 163c163
> < ================================================================================================
> \ No newline at end of file
> ---
>> ================================================================================================
>
>
> On 10 February 2015 at 16:36, Marlon Pierce <ma...@iu.edu> wrote:
>> As always, you can steal from other projects. Did you look at Airavata?
>> One of our mentors held our feet to the fire over this, so hopefully it will
>> serve as a good model for you.
>>
>> Marlon
>>
>>
>> On 2/10/15 11:34 AM, Stian Soiland-Reyes wrote:
>>> Not sure what is the best Maven way to do NOTICE file management when
>>> we have many modules and are going to release JARs in Maven Central. I
>>> would prefer not having to do too much copy and pasting..
>>>
>>>
>>>
>>> As the taverna-scufl2-schemas JAR in this case contains the actual XSD
>>> as well, I've added:
>>>
>>>
>>> https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>>
>>> (Inspired by
>>> http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
>>>
>>>
>>> which then is completed as a velocity template (to get the correct
>>> project name and year), and generates this META-INF/NOTICE file in the
>>> compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
>>>
>>>
>>>> Apache Taverna Scufl 2 Schemas
>>>> Copyright 2015 The Apache Software Foundation
>>>>
>>>> This product includes software developed at
>>>> The Apache Software Foundation (http://www.apache.org/).
>>>>
>>>>
>>>> # xml.xsd
>>>>
>>>> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
>>>> document includes material copied from or derived from:
>>>>
>>>> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
>>>> W3C Recommendation 26 November 2008
>>>> http://www.w3.org/2001/xml.xsd
>>>> http://www.w3.org/TR/xml/
>>>
>>> .. but - the template META-INF/NOTICE.vm is also included in the JAR!
>>> confusing.. but.. not "wrong" legally (it even has an Apache header to
>>> keep RAT happy!).
>>>
>>> Perhaps the Velocity template is taking this too far. If I add this
>>> directly as META-INF/NOTICE it is included only once - but of course
>>> "2015" will/may be out of date next year - but that's 10 greps a year
>>> then. Is that really a problem?
>>>
>>>
>>>
>>> Another question - how are NOTICE files from sub-modules meant to be
>>> aggregated/combined in the source release of the taverna-language
>>> project
>>> (and in the command line/workbench binary releases that will include this
>>> JAR):
>>>
>>>
>>> I tried building taverna-language now with the above, using:
>>>
>>> mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
>>>
>>> and in
>>> target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
>>>
>>> I get an autogenerated NOTICE file that just says:
>>>
>>> Apache Taverna Language APIs (Scufl2, Databundle)
>>> Copyright 2015 The Apache Software Foundation
>>>
>>> This product includes software developed at
>>> The Apache Software Foundation (http://www.apache.org/).
>>>
>>>
>>>
>>> To find that W3C notice you have to hunt around:
>>>
>>>
>>> stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
>>> find . -name '*NOTICE*'
>>> ./NOTICE
>>> ./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>>
>>>
>>> Somehow I feel the mentors would not see this as job done..
>>>
>>>
>>> Would anyone have time to check around if there is some help from
>>> Maven plugins here (see other multi-module Apache projects), or if we
>>> are just going to have to do a copy-paste job and hope we don't get it
>>> wrong?
>>>
>>>
>>>
>>>
>>> On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org>
>>> wrote:
>>>> I have added license headers to all files in taverna-scufl2-schemas -
>>>> all but one were ours.
>>>>
>>>> I guess we would get rid of the duplicates and use Maven dependencies..
>>>>
>>>>
>>>> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
>>>> also into LICENSE?
>>>>
>>>> http://www.w3.org/Consortium/Legal/2015/doc-license
>>>>
>>>> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>>>>> Hello everybody,
>>>>>
>>>>> I have put the licenses on the xsd files that are definitely
>>>>> Taverna-community-created.
>>>>>
>>>>> Alan
>>>>>
>>>> --
>>>> Stian Soiland-Reyes
>>>> Apache Taverna (incubating)
>>>> http://orcid.org/0000-0001-9842-9718
>>>
>>>
>
>
Re: NOTICE files in multi-module Maven projects
Posted by Stian Soiland-Reyes <st...@apache.org>.
Thank you - there are just too many projects to look at!
Jena does this manually, which I've already gotten into trouble because of.. :-)
I had a look at Airavata.
Are these files all made by hand?
stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*'
./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
./modules/distribution/orchestrator-server/src/main/resources/NOTICE
./modules/distribution/xbaya-gui/src/main/resources/NOTICE
./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
./modules/distribution/api-server/src/main/resources/NOTICE
./modules/distribution/gfac-server/src/main/resources/NOTICE
./modules/distribution/client/java/src/main/resources/NOTICE
./modules/distribution/server/src/main/resources/NOTICE
./NOTICE
For example
https://github.com/apache/airavata/blob/master/modules/distribution/gfac-server/src/main/resources/NOTICE
looks pretty auto-generated to me. But perhaps it's just because it's
the same file mostly just copied around?
stain@biggie-utopic:~/src/airavata$ find . -name 'NOTICE*' | xargs wc -l
163 ./airavata-api/airavata-client-sdks/airavata-cpp-sdk/src/main/resources/NOTICE
4 ./airavata-api/airavata-client-sdks/airavata-php-sdk/src/main/resources/NOTICE
163 ./modules/distribution/orchestrator-server/src/main/resources/NOTICE
162 ./modules/distribution/xbaya-gui/src/main/resources/NOTICE
162 ./modules/distribution/xbaya-gui/src/main/resources/jnlp/NOTICE
163 ./modules/distribution/api-server/src/main/resources/NOTICE
163 ./modules/distribution/gfac-server/src/main/resources/NOTICE
163 ./modules/distribution/client/java/src/main/resources/NOTICE
163 ./modules/distribution/server/src/main/resources/NOTICE
6 ./NOTICE
That +/- 1 there is because:
stain@biggie-utopic:~/src/airavata$ diff
./modules/distribution/xbaya-gui/src/main/resources/NOTICE
./modules/distribution/orchestrator-server/src/main/resources/NOTICE
2c2
< Copyright 2013 The Apache Software Foundation
---
> Copyright 2014 The Apache Software Foundation
163c163
< ================================================================================================
\ No newline at end of file
---
> ================================================================================================
On 10 February 2015 at 16:36, Marlon Pierce <ma...@iu.edu> wrote:
> As always, you can steal from other projects. Did you look at Airavata?
> One of our mentors held our feet to the fire over this, so hopefully it will
> serve as a good model for you.
>
> Marlon
>
>
> On 2/10/15 11:34 AM, Stian Soiland-Reyes wrote:
>>
>> Not sure what is the best Maven way to do NOTICE file management when
>> we have many modules and are going to release JARs in Maven Central. I
>> would prefer not having to do too much copy and pasting..
>>
>>
>>
>> As the taverna-scufl2-schemas JAR in this case contains the actual XSD
>> as well, I've added:
>>
>>
>> https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>
>> (Inspired by
>> http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
>>
>>
>> which then is completed as a velocity template (to get the correct
>> project name and year), and generates this META-INF/NOTICE file in the
>> compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
>>
>>
>>> Apache Taverna Scufl 2 Schemas
>>> Copyright 2015 The Apache Software Foundation
>>>
>>> This product includes software developed at
>>> The Apache Software Foundation (http://www.apache.org/).
>>>
>>>
>>> # xml.xsd
>>>
>>> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
>>> document includes material copied from or derived from:
>>>
>>> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
>>> W3C Recommendation 26 November 2008
>>> http://www.w3.org/2001/xml.xsd
>>> http://www.w3.org/TR/xml/
>>
>>
>> .. but - the template META-INF/NOTICE.vm is also included in the JAR!
>> confusing.. but.. not "wrong" legally (it even has an Apache header to
>> keep RAT happy!).
>>
>> Perhaps the Velocity template is taking this too far. If I add this
>> directly as META-INF/NOTICE it is included only once - but of course
>> "2015" will/may be out of date next year - but that's 10 greps a year
>> then. Is that really a problem?
>>
>>
>>
>> Another question - how are NOTICE files from sub-modules meant to be
>> aggregated/combined in the source release of the taverna-language
>> project
>> (and in the command line/workbench binary releases that will include this
>> JAR):
>>
>>
>> I tried building taverna-language now with the above, using:
>>
>> mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
>>
>> and in
>> target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
>>
>> I get an autogenerated NOTICE file that just says:
>>
>> Apache Taverna Language APIs (Scufl2, Databundle)
>> Copyright 2015 The Apache Software Foundation
>>
>> This product includes software developed at
>> The Apache Software Foundation (http://www.apache.org/).
>>
>>
>>
>> To find that W3C notice you have to hunt around:
>>
>>
>> stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
>> find . -name '*NOTICE*'
>> ./NOTICE
>> ./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>>
>>
>> Somehow I feel the mentors would not see this as job done..
>>
>>
>> Would anyone have time to check around if there is some help from
>> Maven plugins here (see other multi-module Apache projects), or if we
>> are just going to have to do a copy-paste job and hope we don't get it
>> wrong?
>>
>>
>>
>>
>> On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org>
>> wrote:
>>>
>>> I have added license headers to all files in taverna-scufl2-schemas -
>>> all but one were ours.
>>>
>>> I guess we would get rid of the duplicates and use Maven dependencies..
>>>
>>>
>>> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
>>> also into LICENSE?
>>>
>>> http://www.w3.org/Consortium/Legal/2015/doc-license
>>>
>>> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>>>>
>>>> Hello everybody,
>>>>
>>>> I have put the licenses on the xsd files that are definitely
>>>> Taverna-community-created.
>>>>
>>>> Alan
>>>>
>>> --
>>> Stian Soiland-Reyes
>>> Apache Taverna (incubating)
>>> http://orcid.org/0000-0001-9842-9718
>>
>>
>>
>
--
Stian Soiland-Reyes
Apache Taverna (incubating)
http://orcid.org/0000-0001-9842-9718
Re: NOTICE files in multi-module Maven projects
Posted by Marlon Pierce <ma...@iu.edu>.
As always, you can steal from other projects. Did you look at
Airavata? One of our mentors held our feet to the fire over this, so
hopefully it will serve as a good model for you.
Marlon
On 2/10/15 11:34 AM, Stian Soiland-Reyes wrote:
> Not sure what is the best Maven way to do NOTICE file management when
> we have many modules and are going to release JARs in Maven Central. I
> would prefer not having to do too much copy and pasting..
>
>
>
> As the taverna-scufl2-schemas JAR in this case contains the actual XSD
> as well, I've added:
>
> https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>
> (Inspired by http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
>
>
> which then is completed as a velocity template (to get the correct
> project name and year), and generates this META-INF/NOTICE file in the
> compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
>
>
>> Apache Taverna Scufl 2 Schemas
>> Copyright 2015 The Apache Software Foundation
>>
>> This product includes software developed at
>> The Apache Software Foundation (http://www.apache.org/).
>>
>>
>> # xml.xsd
>>
>> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
>> document includes material copied from or derived from:
>>
>> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
>> W3C Recommendation 26 November 2008
>> http://www.w3.org/2001/xml.xsd
>> http://www.w3.org/TR/xml/
>
> .. but - the template META-INF/NOTICE.vm is also included in the JAR!
> confusing.. but.. not "wrong" legally (it even has an Apache header to
> keep RAT happy!).
>
> Perhaps the Velocity template is taking this too far. If I add this
> directly as META-INF/NOTICE it is included only once - but of course
> "2015" will/may be out of date next year - but that's 10 greps a year
> then. Is that really a problem?
>
>
>
> Another question - how are NOTICE files from sub-modules meant to be
> aggregated/combined in the source release of the taverna-language
> project
> (and in the command line/workbench binary releases that will include this JAR):
>
>
> I tried building taverna-language now with the above, using:
>
> mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
>
> and in target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
>
> I get an autogenerated NOTICE file that just says:
>
> Apache Taverna Language APIs (Scufl2, Databundle)
> Copyright 2015 The Apache Software Foundation
>
> This product includes software developed at
> The Apache Software Foundation (http://www.apache.org/).
>
>
>
> To find that W3C notice you have to hunt around:
>
> stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
> find . -name '*NOTICE*'
> ./NOTICE
> ./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>
>
> Somehow I feel the mentors would not see this as job done..
>
>
> Would anyone have time to check around if there is some help from
> Maven plugins here (see other multi-module Apache projects), or if we
> are just going to have to do a copy-paste job and hope we don't get it
> wrong?
>
>
>
>
> On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org> wrote:
>> I have added license headers to all files in taverna-scufl2-schemas -
>> all but one were ours.
>>
>> I guess we would get rid of the duplicates and use Maven dependencies..
>>
>>
>> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
>> also into LICENSE?
>>
>> http://www.w3.org/Consortium/Legal/2015/doc-license
>>
>> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>>> Hello everybody,
>>>
>>> I have put the licenses on the xsd files that are definitely
>>> Taverna-community-created.
>>>
>>> Alan
>>>
>> --
>> Stian Soiland-Reyes
>> Apache Taverna (incubating)
>> http://orcid.org/0000-0001-9842-9718
>
>
Re: NOTICE files in multi-module Maven projects
Posted by Stian Soiland-Reyes <st...@apache.org>.
In taverna-scufl2-examples there is a use of the maven-shade-plugin
which I mentioned could be trouble.. but this might be the lucky one!
I tried https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html#ApacheNoticeResourceTransformer
(NOT with that misleading <excludeHeader>false option - that only gave
me a single NOTICE from a random XML dependency)
https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-examples/pom.xml#L139
The resulting META-INF/NOTICE in the standalone.jar should be
compliant - although not too readable:
https://gist.github.com/stain/2385677f01d8f59bf8c8
That doesn't help the appassembler-maven-plugin above.. but that's OK
here, as the folder it makes is not distributed in the binaries.
On 10 February 2015 at 16:34, Stian Soiland-Reyes <st...@apache.org> wrote:
> Not sure what is the best Maven way to do NOTICE file management when
> we have many modules and are going to release JARs in Maven Central. I
> would prefer not having to do too much copy and pasting..
>
>
>
> As the taverna-scufl2-schemas JAR in this case contains the actual XSD
> as well, I've added:
>
> https://github.com/taverna-incubator/incubator-taverna-language/blob/master/taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>
> (Inspired by http://central.maven.org/maven2/org/apache/apache-jar-resource-bundle/1.4/)
>
>
> which then is completed as a velocity template (to get the correct
> project name and year), and generates this META-INF/NOTICE file in the
> compiled taverna-scufl2-schemas-0.16.1-incubating-SNAPSHOT.jar :
>
>
>> Apache Taverna Scufl 2 Schemas
>> Copyright 2015 The Apache Software Foundation
>>
>> This product includes software developed at
>> The Apache Software Foundation (http://www.apache.org/).
>>
>>
>> # xml.xsd
>>
>> Copyright © 2008 W3C® (MIT, ERCIM, Keio, Beihang). This software or
>> document includes material copied from or derived from:
>>
>> - Extensible Markup Language (XML) 1.0 (Fifth Edition)
>> W3C Recommendation 26 November 2008
>> http://www.w3.org/2001/xml.xsd
>> http://www.w3.org/TR/xml/
>
>
> .. but - the template META-INF/NOTICE.vm is also included in the JAR!
> confusing.. but.. not "wrong" legally (it even has an Apache header to
> keep RAT happy!).
>
> Perhaps the Velocity template is taking this too far. If I add this
> directly as META-INF/NOTICE it is included only once - but of course
> "2015" will/may be out of date next year - but that's 10 greps a year
> then. Is that really a problem?
>
>
>
> Another question - how are NOTICE files from sub-modules meant to be
> aggregated/combined in the source release of the taverna-language
> project
> (and in the command line/workbench binary releases that will include this JAR):
>
>
> I tried building taverna-language now with the above, using:
>
> mvn clean install -DskipTests=true -Drat.skip=true -Papache-release
>
> and in target/taverna-language-0.16.1-incubating-SNAPSHOT-source-release.zip
>
> I get an autogenerated NOTICE file that just says:
>
> Apache Taverna Language APIs (Scufl2, Databundle)
> Copyright 2015 The Apache Software Foundation
>
> This product includes software developed at
> The Apache Software Foundation (http://www.apache.org/).
>
>
>
> To find that W3C notice you have to hunt around:
>
> stain@biggie-utopic:~/src/taverna-incubator/incubator-taverna-language/target/taverna-language-0.16.1-incubating-SNAPSHOT$
> find . -name '*NOTICE*'
> ./NOTICE
> ./taverna-scufl2-schemas/src/main/resources/META-INF/NOTICE.vm
>
>
> Somehow I feel the mentors would not see this as job done..
>
>
> Would anyone have time to check around if there is some help from
> Maven plugins here (see other multi-module Apache projects), or if we
> are just going to have to do a copy-paste job and hope we don't get it
> wrong?
>
>
>
>
> On 10 February 2015 at 15:45, Stian Soiland-Reyes <st...@apache.org> wrote:
>> I have added license headers to all files in taverna-scufl2-schemas -
>> all but one were ours.
>>
>> I guess we would get rid of the duplicates and use Maven dependencies..
>>
>>
>> W3C licensing (e.g. xml.xsd) will require a NOTICE mention, probably
>> also into LICENSE?
>>
>> http://www.w3.org/Consortium/Legal/2015/doc-license
>>
>> On 10 February 2015 at 11:52, alaninmcr <al...@googlemail.com> wrote:
>>> Hello everybody,
>>>
>>> I have put the licenses on the xsd files that are definitely
>>> Taverna-community-created.
>>>
>>> Alan
>>>
>>
>> --
>> Stian Soiland-Reyes
>> Apache Taverna (incubating)
>> http://orcid.org/0000-0001-9842-9718
>
>
>
> --
> Stian Soiland-Reyes
> Apache Taverna (incubating)
> http://orcid.org/0000-0001-9842-9718
--
Stian Soiland-Reyes
Apache Taverna (incubating)
http://orcid.org/0000-0001-9842-9718