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

Bugfix: CHANGELOG and LICENSE files are saving to the root site-packages dir #407

Conversation

Pete-rePete
Copy link

@Pete-rePete Pete-rePete commented Nov 12, 2024

Overview

As the title says, CHANGELOG.md and LICENSE files are saving to the root site-packages dir. If you install all the serialization packages, these 2 files get overwritten a few times. Then when uninstalling (or running poetry update for that matter) you quickly run into FileNotFoundError errors and poetry telling you Cannot install microsoft-kiota-serialization-text or any of the other ones.

Proposed Solution

  • For license, you don't even need to include it in the include, it gets detected automatically and is included within the package. (here are the files that get included automatically).
  • For changelog you'd need to do a clever hack like this if you really, really want to include it in the python package. I'd recommend just not including changelog in the python package, I can't conceive a reason why the functional code would need it, so this PR omits it rather than employing any clever hacks

Related Issue

Fixes #406

Notes

Testing Instructions

No testing required

@andrueastman
Copy link
Member

Thanks for creating this @Pete-rePete

Should we also be doing the same for the abstraction,authentication and bundle pacakges?

include = ["CHANGELOG.md", "LICENSE"]

@Pete-rePete
Copy link
Author

@andrueastman fair point! Just made a commit that does the same on the other packages in this repo

@Pete-rePete
Copy link
Author

@microsoft-github-policy-service agree

Copy link
Member

@andrueastman andrueastman 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 contribution and insights @Pete-rePete

@andrueastman andrueastman merged commit ad21998 into microsoft:main Nov 14, 2024
52 checks passed
@Pete-rePete Pete-rePete deleted the serialization-site-packages-changelog-bugfix branch November 20, 2024 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Serialization packages: CHANGELOG.md and LICENSE files are saving to the root site-packages dir
2 participants