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

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

Merged
merged 1 commit into from
Nov 1, 2023

Conversation

sarutak
Copy link
Member

@sarutak sarutak commented Oct 29, 2023

AVRO-3861

What is the purpose of the change

This PR fixes an issue that the RAT check fails if Python API docs built are in lang/py/docs/build.
You can reproduce this issue by the following steps.

  1. Build Python API doc by cd lang/py && ./build.sh doc
  2. Run ./build.sh dist

Then, you can see the following error message.

[WARNING] Files with unapproved licenses:
  lang/py/docs/build/html/_static/pygments.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/alabaster.css
  lang/py/docs/build/html/_static/custom.css
  lang/py/docs/build/html/automodule.html
  lang/py/docs/build/html/index.html
  lang/py/docs/build/html/intro.html
  lang/py/docs/build/html/genindex.html
  lang/py/docs/build/html/py-modindex.html
  lang/py/docs/build/html/search.html
  lang/py/docs/build/html/.buildinfo
  lang/py/docs/build/html/searchindex.js

To fix this issue, this PR addes an exclusion rule to pom.xml for RAT.

Verifying this change

Confirmed ./build.sh dist succeeded even if there are some files in lang/py/docs/build

Documentation

  • Does this pull request introduce a new feature? (no)

@github-actions github-actions bot added the build label Oct 29, 2023
Copy link
Contributor

@paliwalashish paliwalashish left a comment

Choose a reason for hiding this comment

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

+1

@martin-g martin-g merged commit 8fda42a into apache:main Nov 1, 2023
15 checks passed
martin-g pushed a commit that referenced this pull request Nov 1, 2023
@martin-g
Copy link
Member

martin-g commented Nov 1, 2023

Thank you, @sarutak !

RanbirK pushed a commit to RanbirK/avro that referenced this pull request May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants