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

fix: do not include docs/conf.py & scripts in wheel #328

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

mgorny
Copy link
Contributor

@mgorny mgorny commented Jan 8, 2024

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

@mgorny mgorny requested review from a team as code owners January 8, 2024 14:59
@product-auto-label product-auto-label bot added the size: xs Pull request size is extra small. label Jan 8, 2024
@clundin25
Copy link
Contributor

@mgorny Thank you for this change. The contents look correct. It seems the lint check is failing, so please run nox -s blacken to fix the formatting issues, and push those changes.

@parthea
Copy link
Contributor

parthea commented Jan 8, 2024

adding @dandhlee as reviewer for the docs pipeline

@parthea parthea requested a review from dandhlee January 8, 2024 15:48
@mgorny
Copy link
Contributor Author

mgorny commented Jan 8, 2024

Sorry about that, should be fixed now.

@dandhlee
Copy link
Contributor

dandhlee commented Jan 8, 2024

Fine to excludedocs directory for setup, any reason why it's marked as a fix? Have you run into any issues?

@mgorny
Copy link
Contributor Author

mgorny commented Jan 8, 2024

Yes. Since the files are included in wheels, they are installed inside site-packages. This triggers QA checks in Gentoo and causes the build process to error out due to installing forbidden/collision-prone top-level packages.

@dandhlee
Copy link
Contributor

dandhlee commented Jan 9, 2024

Just curious, where/how are you seeing them in site-packages?

Could you elaborate a bit more on how your tool is installing the top level packages?

This also sounds like it's a problem unique to the tool, so I'd mark it as a chore or build prefix rather than fix, unless this is fixing a bug directly related to this repository content.

@mgorny
Copy link
Contributor Author

mgorny commented Jan 9, 2024

To reproduce:

git clone https://github.com/googleapis/google-auth-library-python-oauthlib/
cd google-auth-library-python-oauthlib
python -m venv .venv
. .venv/bin/activate
pip install .
ls .venv/lib/python3.12/site-packages/

You're going to notice that there are docs and scripts directories there.

@mgorny
Copy link
Contributor Author

mgorny commented Jul 9, 2024

Ping.

@arithmetic1728 arithmetic1728 added the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 9, 2024
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jul 9, 2024
@arithmetic1728 arithmetic1728 merged commit 78940df into googleapis:main Jul 9, 2024
16 checks passed
@mgorny mgorny deleted the fix-setup branch July 9, 2024 09:25
@mgorny
Copy link
Contributor Author

mgorny commented Jul 9, 2024

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: xs Pull request size is extra small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants