Add NOTICE file for Beats #3334

monicasarbu · 2017-01-10T22:08:44Z

This PR contains a python script that generates the NOTICE file. There is a single NOTICE file for all the official Beats, and it's placed in the beats repository.

The NOTICE file includes the copyright information for all the 3rd party libraries used in the Beats project. It follows the rules:

if the library has apache license, and if NOTICE file is present, include that text in the NOTICE file.
if the library has MIT, ISC or BSD license, include the whole copyright block in NOTICE file (meaning copyright + license)

You can pass a list of vendor directories where the NOTICE* and LICENSE* files of all 3rd party libraries are available:

python dev-tools/generate_notice.py vendor metricbeat/vendor

For the official Beats, you can run the following in the beats repository.

make notice

The NOTICE file can be generated by the community Beats by using the script. The NOTICE file is not added by the Beat generator.

UPDATE: The script accepts also the name of the Beat and the copyright owner, to customize the NOTICE file for the community Beats.

$ python dev-tools/generate_notice.py -h
usage: generate_notice.py [-h] [-b BEAT] [-c COPYRIGHT] vendors [vendors ...]

Generate the NOTICE file from a list of vendor directories

positional arguments:
  vendors               List of vendor directories

optional arguments:
  -h, --help            show this help message and exit
  -b BEAT, --beat BEAT  Beat name
  -c COPYRIGHT, --copyright COPYRIGHT
                        Copyright owner

ruflin · 2017-01-11T07:46:06Z

metricbeat/NOTICE

@@ -0,0 +1,1692 @@
+License /Users/monica/src/github.com/elastic/beats/metricbeat/vendor/github.com/mitchellh/hashstructure/LICENSE


We should not include here the full path as it contains your private username. Perhaps we can replace it by $GOPATH or just make it relative to the repo.

Yes, sure. The plan is to include only github.com/mitchellh/hashstructure.

ruflin · 2017-01-11T07:47:45Z

dev-tools/generate_notice.py

+	vendors = [beat_dir, libbeat_dir]
+	licenses = []
+
+	for vendor in vendors:


Will this also include vendor directories inside metricbeat modules?

ruflin · 2017-01-11T07:53:56Z

This could also be interesting to see which repos do not contain a license file: https://github.com/pmezard/licenses

cyrilleverrier · 2017-01-11T12:30:52Z

This PR is going to be useful for community beats as well :)

monicasarbu · 2017-01-11T21:28:15Z

@cyrilleverrier Thank you for such a quick feedback. I added two options (-b and -c) to configure the Beat name and the copyright owner. I have updated the description of the PR with the script usage.

ruflin · 2017-01-12T07:53:49Z

Makefile

+
+.PHONY: notice
+notice: 
+	python dev-tools/generate_notice.py metricbeat/vendor vendor


This does not include the vendor directories in the metricbeat modules? How about somthing like find . -name vendor?

Ah, good point. Then I will search in a given director for all the vendor directories.

ruflin · 2017-01-12T07:54:30Z

dev-tools/generate_notice.py

+    lib = ""
+    path = os.path.dirname(license)
+    # get the last three directories
+    for i in range(0, 3):


Does this also work for dependencies not on Github?

It gets only the last 3rd directories from the path, but the function should be able to get less than 3 directories as well. I adjusted the code a bit to accept also less than 3 directories (example windows/project)

The script receives a directory and searches for all the all vendor subdirectories in order to extract copyright information about the 3rd party libraries that are used. The NOTICE file is generated in the current directory. For each 3rd party library, the following rules are used: - If the library has apache license, and if NOTICE file is present, include that text in the NOTICE file. - If the library has MIT, ISC or BSD license, include the whole copyright block in NOTICE file (meaning copyright + license)

tsg

LGTM

* Python script to generate the NOTICE file The script receives a directory and searches for all the all vendor subdirectories in order to extract copyright information about the 3rd party libraries that are used. The NOTICE file is generated in the current directory. For each 3rd party library, the following rules are used: - If the library has apache license, and if NOTICE file is present, include that text in the NOTICE file. - If the library has MIT, ISC or BSD license, include the whole copyright block in NOTICE file (meaning copyright + license) * Accept also 3rd party libraries with less than 3 directories (cherry picked from commit e2aaa38)

* Add NOTICE file for Beats (#3334) * Python script to generate the NOTICE file The script receives a directory and searches for all the all vendor subdirectories in order to extract copyright information about the 3rd party libraries that are used. The NOTICE file is generated in the current directory. For each 3rd party library, the following rules are used: - If the library has apache license, and if NOTICE file is present, include that text in the NOTICE file. - If the library has MIT, ISC or BSD license, include the whole copyright block in NOTICE file (meaning copyright + license) * Accept also 3rd party libraries with less than 3 directories (cherry picked from commit e2aaa38) * Add NOTICE file to the packages (#3379) Added to the home path. Also modifies the generators to include a simple NOTICE file, which is anyway good practice for Apache licensed projects. Tested the beat and the metricbeat generators by hand. (cherry picked from commit f3352eb)

* Add NOTICE file for Beats (elastic#3334) * Python script to generate the NOTICE file The script receives a directory and searches for all the all vendor subdirectories in order to extract copyright information about the 3rd party libraries that are used. The NOTICE file is generated in the current directory. For each 3rd party library, the following rules are used: - If the library has apache license, and if NOTICE file is present, include that text in the NOTICE file. - If the library has MIT, ISC or BSD license, include the whole copyright block in NOTICE file (meaning copyright + license) * Accept also 3rd party libraries with less than 3 directories (cherry picked from commit da690f7) * Add NOTICE file to the packages (elastic#3379) Added to the home path. Also modifies the generators to include a simple NOTICE file, which is anyway good practice for Apache licensed projects. Tested the beat and the metricbeat generators by hand. (cherry picked from commit 3e63f7b)

monicasarbu force-pushed the add_notice_file branch 3 times, most recently from d819c70 to 432609c Compare January 10, 2017 22:32

monicasarbu added the in progress Pull request is currently in progress. label Jan 10, 2017

monicasarbu force-pushed the add_notice_file branch from 7061edd to f2b9c32 Compare January 10, 2017 23:11

ruflin reviewed Jan 11, 2017

View reviewed changes

monicasarbu force-pushed the add_notice_file branch 2 times, most recently from 47b59f7 to 274fac6 Compare January 11, 2017 12:00

monicasarbu added review and removed in progress Pull request is currently in progress. labels Jan 11, 2017

monicasarbu force-pushed the add_notice_file branch from 965a018 to 441e5e2 Compare January 11, 2017 12:26

monicasarbu changed the title ~~Add NOTICE file for Metricbeat~~ Add NOTICE file for Beats Jan 11, 2017

monicasarbu force-pushed the add_notice_file branch 2 times, most recently from 505934b to b7c0a6b Compare January 11, 2017 13:17

monicasarbu added the in progress Pull request is currently in progress. label Jan 11, 2017

monicasarbu force-pushed the add_notice_file branch from 1fe45e8 to 8f7f2f8 Compare January 11, 2017 14:15

monicasarbu removed the in progress Pull request is currently in progress. label Jan 11, 2017

ruflin reviewed Jan 12, 2017

View reviewed changes

monicasarbu force-pushed the add_notice_file branch from 48fc892 to 529e477 Compare January 12, 2017 10:44

Accept also 3rd party libraries with less than 3 directories

7c6e34b

tsg reviewed Jan 16, 2017

View reviewed changes

tsg merged commit e2aaa38 into elastic:master Jan 16, 2017

monicasarbu deleted the add_notice_file branch January 16, 2017 11:02

tsg mentioned this pull request Jan 16, 2017

Add NOTICE file to the packages #3379

Merged

tsg added the needs_backport PR is waiting to be backported to other branches. label Jan 16, 2017

tsg mentioned this pull request Jan 16, 2017

Backport 3334 & 3379 to 5.2: Notice file #3380

Merged

tsg removed the needs_backport PR is waiting to be backported to other branches. label Jan 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add NOTICE file for Beats #3334

Add NOTICE file for Beats #3334

monicasarbu commented Jan 10, 2017 •

edited

Loading

ruflin Jan 11, 2017 •

edited

Loading

monicasarbu Jan 11, 2017

ruflin Jan 11, 2017

ruflin commented Jan 11, 2017

cyrilleverrier commented Jan 11, 2017

monicasarbu commented Jan 11, 2017

ruflin Jan 12, 2017

monicasarbu Jan 12, 2017

ruflin Jan 12, 2017

monicasarbu Jan 12, 2017

tsg left a comment

		@@ -0,0 +1,1692 @@
		License /Users/monica/src/github.com/elastic/beats/metricbeat/vendor/github.com/mitchellh/hashstructure/LICENSE

Add NOTICE file for Beats #3334

Add NOTICE file for Beats #3334

Conversation

monicasarbu commented Jan 10, 2017 • edited Loading

ruflin Jan 11, 2017 • edited Loading

Choose a reason for hiding this comment

monicasarbu Jan 11, 2017

Choose a reason for hiding this comment

ruflin Jan 11, 2017

Choose a reason for hiding this comment

ruflin commented Jan 11, 2017

cyrilleverrier commented Jan 11, 2017

monicasarbu commented Jan 11, 2017

ruflin Jan 12, 2017

Choose a reason for hiding this comment

monicasarbu Jan 12, 2017

Choose a reason for hiding this comment

ruflin Jan 12, 2017

Choose a reason for hiding this comment

monicasarbu Jan 12, 2017

Choose a reason for hiding this comment

tsg left a comment

Choose a reason for hiding this comment

monicasarbu commented Jan 10, 2017 •

edited

Loading

ruflin Jan 11, 2017 •

edited

Loading