You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@daffodil.apache.org by GitBox <gi...@apache.org> on 2020/04/08 21:37:15 UTC

[GitHub] [incubator-daffodil] stevedlawrence opened a new pull request #359: Add sbt configuration to generate licenses to be included in jars

stevedlawrence opened a new pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359

We currently include the root LICENSE and NOTICE file in each of the
jars that we create and distribute. However, those files define the
license of all the source code in the repository, and is not specific to
each submodule the jar represents. Furthermore, the license references
files that don't actually exist in a jar. We really need a unique
license and notice for each submodule we distribute to include in each
jar.

To minimize maintenance cost and ease the ability to make updates, this
adds the ability to generate these licenses. A new GenJarLicense.scala
sbt configuration is added to define a resource generator that creates
the LICENSE and NOTICE files to be included in the META-INF directory in
a jar. This defaults to just the Apache v2 LICENSE and a plain Daffodil
NOTICE file.

Two sbt setting keys are also defined that allow individual submodules
to set additional license or notice information specific to that
submodules jar. The daffodil-lib submodule is the only jar that we
distribute that currently requires additional license information, so
this also includes an sbt configuration for that submodule to provide
that information.

DAFFODIL-2321

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [incubator-daffodil] stevedlawrence commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

stevedlawrence commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359#discussion_r406162486
 
 

 ##########
 File path: daffodil-lib/build.sbt
 ##########
 @@ -0,0 +1,131 @@
+/*
+ * 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.
+ */
+
+import GenJarLicense._
+
+additionalJarLicenseText := Some(
 
 Review comment:
   PR https://github.com/apache/incubator-daffodil/pull/360 is an alternative to this one that just manages the licenses manually and removes the complexity of the generator.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-daffodil] mbeckerle commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

mbeckerle commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359#discussion_r406145752
 
 

 ##########
 File path: daffodil-lib/build.sbt
 ##########
 @@ -0,0 +1,131 @@
+/*
+ * 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.
+ */
+
+import GenJarLicense._
+
+additionalJarLicenseText := Some(
 
 Review comment:
   Thanks for the reminder. I had forgotten about this stuff, but I can see how automated license management would require quite a bit more adherence to various standard ways to advertise one's license, and the world of licenses is just too chaotic out there for that. 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-daffodil] stevedlawrence closed pull request #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

stevedlawrence closed pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-daffodil] mbeckerle commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

mbeckerle commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359#discussion_r405839552

##########
File path: daffodil-lib/build.sbt
##########
@@ -0,0 +1,131 @@
+/*
+ * 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.
+ */
+
+import GenJarLicense._
+
+additionalJarLicenseText := Some(

Review comment:
Wait so, I have to edit this special sbt file in order to get these licenses put into the Jar? Why not just put plaintext files in a directory the entire contents of which is put into the jar?

Didn't we have a sbt plugin to pull down all the licenses based on managed dependencies, and the we somehow generated a web page from that? I don't see that page on our project site now though.....

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [incubator-daffodil] stevedlawrence commented on issue #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

stevedlawrence commented on issue #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359#issuecomment-611550347
 
 
   Closing in preference for PR https://github.com/apache/incubator-daffodil/pull/360, this is just unnecessary complexity for not much gain.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-daffodil] stevedlawrence commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars

Posted by GitBox <gi...@apache.org>.

stevedlawrence commented on a change in pull request #359: Add sbt configuration to generate licenses to be included in jars
URL: https://github.com/apache/incubator-daffodil/pull/359#discussion_r406143089

Review comment:
Each submodule can have a build.sbt file added to provide submodule specific properties. This change defined a new property that submodule can set if they want additional license text specific to the submodule added to the generic Apache license that gets put in the jar. I was just rying to reduce dupliation, but I'll create an alternative pull request that just manages all the files manually and gets rid of the generator and see which is better. Manageing this additional licenses probably isn't significantly more effort, and is certainly more clear.

The problem with that plugin was that it only specifiied licenses of dependencies, and only if those dependencies included license information. Many didn't, or was incomplete, so we had to do a lot of manual effort to get the result correct. It just wasn't sufficient for Apache's licensing needs.

Additionally, that plugin didn't do anything for Apache license compatible code that we took and put in our source tree/jars. E.g. XML schemas, some sutff we took from scala. These aren't dependencies, we just copied code into our tree, so sbt doesn't know anythinga bout those. Those kinds of things are the things to go in these license since we actually distribute those. We don't distribute dependencies except for in your CLI package, which includes a separate license informatino for each dependency.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services