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

Include all files in sdist archives #1785

Merged
merged 1 commit into from
May 17, 2023
Merged

Conversation

mgorny
Copy link
Contributor

@mgorny mgorny commented May 17, 2023

Description

Remove the restriction on files inclduded in sdist archives in order to include documentation sources and tests there. This is the default hatchling behavior and it is helpful to packagers (such as Linux distributions or Conda) as it permits using sdist archives to do packaging (instead of GitHub archives that are not guaranteed to be reproducible). Most of the ordinary users will not be affected since starlette is a pure Python package and therefore pip will prefer wheels to install it everywhere.

Checklist:

  • I have added the relevant tests for this change.
  • I have added an item to the Pending section of docs/changes.rst.

Remove the restriction on files inclduded in sdist archives in order
to include documentation sources and tests there.  This is the default
hatchling behavior and it is helpful to packagers (such as Linux
distributions or Conda) as it permits using sdist archives to do
packaging (instead of GitHub archives that are not guaranteed
to be reproducible).  Most of the ordinary users will not be affected
since starlette is a pure Python package and therefore pip will prefer
wheels to install it everywhere.
@mgorny
Copy link
Contributor Author

mgorny commented May 17, 2023

I haven't added it to changelog since it is primarily packager-facing change rather than developer/user-facing. If you'd like me to add it there nevertheless, please let me know.

@matthiask
Copy link
Member

Doesn't this mean that a tests package is installed into users virtualenvs? I'm not sure this is what we want?

@mgorny
Copy link
Contributor Author

mgorny commented May 17, 2023

No, it's not. The tool.hatch.build.targets.sdist affects only sdist archives, tool.hatch.build.targets.wheel control what goes into wheels and therefore what is installed.

@matthiask
Copy link
Member

Thanks for confirming!

I agree with the assessment that this doesn't have any effect on users then, a changelog entry isn't required then.

@matthiask matthiask merged commit 4a69612 into django-commons:main May 17, 2023
@mgorny mgorny deleted the full-sdist branch May 17, 2023 07:52
@mgorny
Copy link
Contributor Author

mgorny commented May 17, 2023

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants