[AVRO-3861] [Build] Add RAT exclusions for python docs

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.12.0, 1.11.3
• Fix Version/s: 1.12.0, 1.11.4
• Component/s: build
• Labels: pull-request-available
• Assignee: Kousuke Saruta
• Reporter: Ryan Skraba
• Created: 20/Sep/23 12:53
• Updated: 01/Nov/23 09:38
• Resolved: 01/Nov/23 09:38

Description

When following the release process and doing a ./build.sh clean test dist we get the following error:

[INFO] --- apache-rat-plugin:0.15:check (default) @ avro-toplevel ---
[INFO] Enabled default license matchers.
[INFO] Will parse SCM ignores for exclusions...
[INFO] Parsing exclusions from /home/ryan.skraba/avro/.gitignore
[INFO] Finished adding exclusions from SCM ignore files.
[INFO] 88 implicit excludes.
[INFO] 131 explicit excludes.
[INFO] 5630 resources included
[INFO] Rat check: Summary over all files. Unapproved: 17, unknown: 17, generated: 0, approved: 1580 licenses.
[INFO] Enabled default license matchers.
[INFO] Will parse SCM ignores for exclusions...
[INFO] Parsing exclusions from /home/ryan.skraba/avro/.gitignore
[INFO] Finished adding exclusions from SCM ignore files.
[INFO] 88 implicit excludes.
[INFO] 131 explicit excludes.
[INFO] 5630 resources included
[WARNING] Files with unapproved licenses:
  lang/py/docs/build/html/searchindex.js
  lang/py/docs/build/html/.buildinfo
  lang/py/docs/build/html/search.html
  lang/py/docs/build/html/py-modindex.html
  lang/py/docs/build/html/genindex.html
  lang/py/docs/build/html/intro.html
  lang/py/docs/build/html/index.html
  lang/py/docs/build/html/automodule.html
  lang/py/docs/build/html/_static/alabaster.css
  lang/py/docs/build/html/_static/custom.css
  lang/py/docs/build/html/_static/basic.css
  lang/py/docs/build/html/_static/doctools.js
  lang/py/docs/build/html/_static/documentation_options.js
  lang/py/docs/build/html/_static/language_data.js
  lang/py/docs/build/html/_static/searchtools.js
  lang/py/docs/build/html/_static/sphinx_highlight.js
  lang/py/docs/build/html/_static/pygments.css
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.428 s
[INFO] Finished at: 2023-09-20T12:50:06Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.rat:apache-rat-plugin:0.15:check (default) on project avro-toplevel: Too many files with unapproved license: 17 See RAT report in: /home/ryan.skraba/avro/target/rat.txt -> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

The workaround is to do a `./build.sh clean test` followed by a `./build.sh clean dist`, but this should probably be fixed.

Issue Links

• links to: GitHub Pull Request #2572