Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MNG-6771 Fix license issues on binary distribution #297

Merged
merged 1 commit into from Nov 18, 2019
Merged

Conversation

eolivelli
Copy link
Contributor

@eolivelli eolivelli commented Oct 26, 2019

Draft PR for https://issues.apache.org/jira/browse/MNG-6771

  • Start fixing the template for LICENSE file
  • Have consistent naming for LICENSE file and final jars by removing 'classifier' from the name of jars
  • Introduce a script to check for license, from Apache BookKeeper project, original author ivank@apache.org

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MNG-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MNG-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

apache-maven/src/main/assembly/component.xml Outdated Show resolved Hide resolved
set -e

TARBALL="$1"
if [ -z $TARBALL ]; then
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just the adaptation of
https://github.com/apache/bookkeeper/blob/master/dev/check-binary-license

That in turn verifies for
http://bookkeeper.apache.org/community/licensing

We will adapt it to whatever rules we decide for Maven

we could also convert to a Groovy/Python script,
honestly I would love to see these kind of checks in the "Apache RAT" project

if [ $EXIT != 0 ]; then
echo
echo "It looks like there are issues with the LICENSE/NOTICE (error $EXIT)".
echo See http://bookkeeper.apache.org/community/licensing for details on how to fix.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is to be changed

dev/check-binary-license Outdated Show resolved Hide resolved
@eolivelli
Copy link
Contributor Author

@hboutemy I have fixed the download of ASL license files.
I have also added a tweak to bundle jsoup license: add an explicit dependency and then exlucde the jar file from the "lib" directory.

I can't find the point in code where we are generating the NOTICE file for the Binary distribution.
It is not a raw source file copied from somewhere.

I need to be able to manually write this file.
This is the last step in this work

@eolivelli
Copy link
Contributor Author

@hboutemy when I am referring to '.license' files I am talking about this line:
https://github.com/apache/maven/blob/master/apache-maven/src/main/appended-resources/META-INF/LICENSE.vm#L54

that makes that the license files are downloaded to lib/xxxx.license

@hboutemy
Copy link
Member

I have also added a tweak to bundle jsoup license: add an explicit dependency and then exlucde the jar file from the "lib" directory.

nice tweak :)

I can't find the point in code where we are generating the NOTICE file for the Binary distribution.

it comes from maven-remote-resources-plugin processing org.apache:apache-jar-resource-bundle:1.4, cf https://github.com/apache/maven-resources/tree/trunk/apache-jar-resource-bundle/src/main/resources/META-INF

@asfgit asfgit force-pushed the MNG-6771 branch 2 times, most recently from e91e02f to eae228d Compare November 16, 2019 23:11
@eolivelli
Copy link
Contributor Author

Thank you @hboutemy for moving forward.
The last step is to create the NOTICE file.
Are you working on it ?
I have time to do the first step this evening. I will go thru the list of depedencies and collect manually all of the texts to be reported in NOTICE file

@eolivelli
Copy link
Contributor Author

@hboutemy I have written on JIRA the contents I think we need to write in NOTICE
is there any way to append contents to it comes from maven-remote-resources-plugin processing org.apache:apache-jar-resource-bundle:1.4, cf https://github.com/apache/maven-resources/tree/trunk/apache-jar-resource-bundle/src/main/resources/META-INF

without releasing a new version of maven-resources ?

@hboutemy
Copy link
Member

hboutemy commented Nov 17, 2019

@eolivelli if you copy LICENSE.vm to NOTICE.vm, you'll see that you can do the same Velocity append in NOTICE than what is currently done for LICENSE

@hboutemy
Copy link
Member

ok for me

@hboutemy hboutemy marked this pull request as ready for review November 17, 2019 23:08
@hboutemy hboutemy self-requested a review November 17, 2019 23:08
- Update slf4j to 1.7.29
- Do not download ASL v2 license files but copy from local
- add Jsoup license
- keep a specific copy of MIT license for each dependency
- Add NOTICE to binary distribution
- Add Eclipse SISU about.html contents

Patch co-authored by Hervé Boutemy and Enrico Olivelli
@eolivelli
Copy link
Contributor Author

Thank you @hboutemy
I will merge as soon as CI is blue https://builds.apache.org/job/maven-box/job/maven/job/MNG-6771/15/

@eolivelli eolivelli merged commit f8bd6d5 into master Nov 18, 2019
@eolivelli
Copy link
Contributor Author

committed as f8bd6d5

thank you so much @hboutemy !

@asfgit asfgit deleted the MNG-6771 branch January 15, 2020 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants