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.

Sign up for GitHub

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

Jump to bottom

feat: Add license checking tool #11398

Merged
merged 27 commits into from
Jul 28, 2022
Merged

feat: Add license checking tool #11398

merged 27 commits into from
Jul 28, 2022

Conversation

srebhan
Copy link
Member

@srebhan srebhan commented Jun 28, 2022 •
edited
Loading

This PR adds a small tool to verify the license information in docs/LICENSE_OF_DEPENDENCIES.md against the repository content of the individual dependencies.

To run the tool first build it with make build_tools and then

./tools/license_checker/license_checker -whitelist ./tools/license_checker/data/whitelist -cache .licenses.cache .

This will use the whitelisting for github.com/eclipse/paho.mqtt.golang and caches the classification results.

@srebhan srebhan requested a review from sspaink June 28, 2022 12:16
@telegraf-tiger telegraf-tiger bot added the feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin label Jun 28, 2022
powersj
powersj reviewed Jun 28, 2022
View reviewed changes
Copy link
Contributor

@powersj powersj left a comment

Choose a reason for hiding this comment

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

Briefly looked through this, this needs a README on how to run it and details on the whitelist documented.

Other than the items in the whitelist, have you run into many mistakes or issues with trying to parse the licenses? I see the threshold setting and was wondering if you had to play with it to get this to work consistently?

go.mod Outdated Show resolved Hide resolved
go.mod Outdated Show resolved Hide resolved
tools/license_checker/cache.go Outdated Show resolved Hide resolved
@srebhan srebhan requested a review from powersj June 29, 2022 19:43
@srebhan srebhan mentioned this pull request Jul 21, 2022
Merged
@srebhan
Add license checker.
d0cf3e9
@srebhan
Add whitelist.
544e1cf
@srebhan
Implement expiry of cache.
9092f70
@srebhan
Add license checker build to makefile.
5fe137a
@srebhan
Fix license information for 'github.com/Azure/azure-sdk-for-go'
7f5a259
@srebhan
Warn if whitelist entry does not match the expectations.
7beabea
@srebhan
Whitelist 'github.com/ClickHouse/clickhouse-go' as license changed be…
acb3a44 
…tween v1 and v2.
@srebhan
Fix link for and whitelist 'github.com/couchbase/goutils' as license …
b74e90d 
…changed in between last tag and master.
@srebhan
Fix link for 'github.com/couchbase/goutils'.
7862a30
@srebhan
Fix license link for 'github.com/harlow/kinesis-consumer'.
47ef248
@srebhan
Fix license information for 'github.com/hashicorp/go-hclog'.
26c0ecd
@srebhan
Fix license link for 'github.com/hashicorp/go-immutable-radix'.
0379ee6
@srebhan
Fix license link for 'github.com/josharian/intern'.
dddef8b
@srebhan
Move license-name to SPDX mapping to file and add BSD-2-Clause-Views.
cea1501
@srebhan
Fix license information for 'github.com/rcrowley/go-metrics'.
1a46b65
@srebhan
Fix license information for 'gopkg.in/yaml.v3'.
04b7a06
@srebhan
Fix license link for 'github.com/DataDog/datadog-agent'.
6b0f568
@srebhan
Sort whitelist.
358e064
@srebhan
Fix linter issues.
0c74f85
@srebhan
Sort packages in go.mod.
522e4bd
@srebhan
Add better help text and make the path optional.
9b3f740
@srebhan
Add README.md.
2246391
@srebhan
Fix linter issues.
f95a382
@srebhan
Remove cache.
b44f8ca
@srebhan
Copy link
Member Author

srebhan commented Jul 27, 2022

@MyaLongmire and @sspaink removed the cache as discussed and added to nightly build. Please have a look and let me know what you think!

sspaink
sspaink reviewed Jul 27, 2022
View reviewed changes
.circleci/config.yml Outdated Show resolved Hide resolved
@telegraf-tiger
Copy link
Contributor

Download PR build artifacts for linux_amd64.tar.gz, darwin_amd64.tar.gz, and windows_amd64.zip.
Downloads for additional architectures and packages are available below.

☺️ This pull request doesn't significantly change the Telegraf binary size (less than 1%)

📦 Click here to get additional PR build artifacts

Artifact URLs

DEB RPM TAR GZ ZIP
amd64.deb aarch64.rpm darwin_amd64.tar.gz windows_amd64.zip
arm64.deb armel.rpm darwin_arm64.tar.gz windows_i386.zip
armel.deb armv6hl.rpm freebsd_amd64.tar.gz
armhf.deb i386.rpm freebsd_armv7.tar.gz
i386.deb ppc64le.rpm freebsd_i386.tar.gz
mips.deb riscv64.rpm linux_amd64.tar.gz
mipsel.deb s390x.rpm linux_arm64.tar.gz
ppc64el.deb x86_64.rpm linux_armel.tar.gz
riscv64.deb linux_armhf.tar.gz
s390x.deb linux_i386.tar.gz
linux_mips.tar.gz
linux_mipsel.tar.gz
linux_ppc64le.tar.gz
linux_riscv64.tar.gz
linux_s390x.tar.gz
static_linux_amd64.tar.gz

sspaink
sspaink approved these changes Jul 28, 2022
View reviewed changes
Copy link
Contributor

@sspaink sspaink left a comment

Choose a reason for hiding this comment

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

Thank you for making this!

powersj
powersj approved these changes Jul 28, 2022
View reviewed changes
Copy link
Contributor

@powersj powersj left a comment

Choose a reason for hiding this comment

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

Awesome! Thank you!

@sspaink sspaink merged commit fd84042 into influxdata:master Jul 28, 2022
@sjwang90 sjwang90 mentioned this pull request Sep 7, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sspaink sspaink sspaink approved these changes

@powersj powersj powersj approved these changes

Assignees
No one assigned
Labels
feat Improvement on an existing feature such as adding a new setting/mode to an existing plugin
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@srebhan @sspaink @powersj