Skip to content
This repository has been archived by the owner on Jul 6, 2023. It is now read-only.

fix: exclude docs and tests from package #63

Merged
merged 2 commits into from
Jun 17, 2021

Conversation

msdinit
Copy link
Contributor

@msdinit msdinit commented Jun 17, 2021

Currently, packages tests and docs are installed (because they are discovered as valid packages by PEP420PackageFinder), which can break user's code if they also use test as a location for their tests, due to package name conflict.

To reproduce - install this package from pypi, see that tests package is present in your venv's site-packages.
This change pretty much follows what other Google packages do, eg here

@msdinit msdinit requested a review from a team as a code owner June 17, 2021 12:11
@product-auto-label product-auto-label bot added the api: workflows Issues related to the googleapis/python-workflows API. label Jun 17, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Jun 17, 2021
Currently, packages `tests` and `docs` are installed (because they are discovered as valid packages by `PEP420PackageFinder`), which can break user's code if they also use `test` as a location for their tests, due to package name conflict.
@parthea parthea added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 17, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 17, 2021
parthea
parthea previously approved these changes Jun 17, 2021
Copy link
Contributor

@parthea parthea left a comment

Choose a reason for hiding this comment

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

Thanks for the fix, @msdinit!

@parthea parthea added the automerge: exact Summon MOG for automerging, but approvals need to be against the latest commit label Jun 17, 2021
@parthea parthea changed the title Prevent unrelated packages from being installed fix: exclude docs and tests from package Jun 17, 2021
@parthea parthea added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 17, 2021
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 17, 2021
@gcf-merge-on-green gcf-merge-on-green bot dismissed parthea’s stale review June 17, 2021 14:58

This review does not reference the most recent commit, and you are using the secure version of merge-on-green. Please re-review the most recent commit.

@parthea parthea added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 17, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 17, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit ff68d16 into googleapis:master Jun 17, 2021
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge: exact Summon MOG for automerging, but approvals need to be against the latest commit label Jun 17, 2021
@msdinit msdinit deleted the patch-1 branch June 17, 2021 15:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api: workflows Issues related to the googleapis/python-workflows API. cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants