-
Notifications
You must be signed in to change notification settings - Fork 588
HDDS-10498. Improved configuration for license compliance #6358
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
HDDS-10498. Improved configuration for license compliance #6358
Conversation
adoroszlai
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @myskov for working on this.
dev-support/rat/rat-exclusions.txt
Outdated
| .github/* | ||
| CONTRIBUTING.md | ||
| README.md | ||
| SECURITY.md | ||
| .gitattributes | ||
| src/main/resources/proto.lock | ||
| **/output.xml | ||
| **/log.html | ||
| **/report.html | ||
| **/.ssh/id_rsa* | ||
| src/test/resources/*.log | ||
| src/test/resources/ssl/* | ||
| **/dependency-reduced-pom.xml | ||
| **/pnpm-lock.yaml | ||
| src/test/resources/prometheus-test-response.txt | ||
| src/main/license/** | ||
| src/main/resources/proto.lock | ||
| src/test/resources/test.db.ini | ||
| tools/fault-injection-service/README.md | ||
| **/webapps/static/angular-nvd3-1.0.9.min.js | ||
| **/webapps/static/angular-route-1.8.0.min.js | ||
| **/webapps/static/bootstrap-3.4.1/** | ||
| **/webapps/static/d3-3.5.17.min.js | ||
| **/webapps/static/jquery-3.5.1.min.js | ||
| **/webapps/static/nvd3-1.8.5.min.css.map | ||
| **/webapps/static/nvd3-1.8.5.min.css | ||
| **/webapps/static/nvd3-1.8.5.min.js.map | ||
| **/webapps/static/nvd3-1.8.5.min.js | ||
| **/webapps/static/angular-1.8.0.min.js | ||
| src/test/resources/additionalfields.container | ||
| src/test/resources/incorrect.checksum.container | ||
| src/test/resources/incorrect.container | ||
| src/test/resources/test.db.ini | ||
| src/test/resources/123-dn-container.db/** | ||
| src/test/resources/123.container | ||
| static/slides/* | ||
| **/themes/ozonedoc/** | ||
| **/*.json No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to sort these.
To make the script useful for local run by devs, we should also exclude:
dev-support/ci/bats-assert/**
dev-support/ci/bats-support/**
.dev-tools/**
(Would be useful if we could exclude everything in .gitignore by default...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be useful if we could exclude everything in .gitignore by default...
As it's in the root folder now, it behaves exactly as you suggested.( parseSCMIgnoresAsExcludes is enabled by default https://creadur.apache.org/rat/apache-rat-plugin/check-mojo.html)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @myskov for the info and updating the patch.
It seems Rat 0.13 does not use .gitignore correctly, the check fails due to the items I suggested (when not included in rat-exclusions.txt). Upgrading to latest Rat 0.16.1 solves false positive for those.
The only item it still reports is .hugo_build.lock. The problem seems to be that it looks for .gitignore only in the module directory tree:
[INFO] --- apache-rat-plugin:0.16.1:check (default-cli) @ hdds-docs ---
...
[DEBUG] Recursively loading .gitignore files in hadoop-hdds/docs
So I suggest:
- upgrade to 0.16.1 (adoroszlai@301b56b)
- split some items from
.gitignoreto module-level files (adoroszlai@82f0a4b)
BTW, steps that create the files reported by Rat as false positives:
- build docs:
mvn -pl :hdds-docs clean package(for.hugo_build.lock) - run bats check:
hadoop-ozone/dev-support/checks/bats.sh(fordev-support/ci/bats-*)
|
Thanks @myskov for the patch. I'll post a follow-up PR with the suggested changes. |
|
Thank you @adoroszlai |
To improve Apache Rat configuration and Ozone maven config, I have done:
What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-10498
How was this patch tested?