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

Compatibility with check-sdist #147

Open
jamesbraza opened this issue Oct 14, 2024 · 7 comments
Open

Compatibility with check-sdist #147

jamesbraza opened this issue Oct 14, 2024 · 7 comments

Comments

@jamesbraza
Copy link
Contributor

If I use build-and-inspect-python-package in normal CI, do I still need https://github.com/henryiii/check-sdist?

  • If BAIPP is a superset of check-sdist: can we document that it's no longer necessary in the README.md
  • Otherwise if BAIPP is not a superset of check-sdist: can we add check-sdist to the internals of BAIPP?
@hynek
Copy link
Owner

hynek commented Oct 14, 2024

let's ask @henryiii :)

@henryiii
Copy link
Contributor

I've wondered about adding it. Check-sdist checks to see if every file in git is included in the SDist. (It's like check-manifest, but for any backend.) It's not very useful for hatch or scikit-build-core projects, as they are based on the git contents too (slightly different, so not useless), but it's really useful for flit-core projects and other backends that don't use git for the file list (like setuptools). The problem with adding it is you might need a bit of configuration if you are intentionally avoiding files from your SDist like CI files. Adding it could cause a previously passing job to start failing, with the fix only being adding some configuration. Check-wheel-contents has similar issues, though, to be fair, the only difference being that has been there longer.

@hynek
Copy link
Owner

hynek commented Oct 14, 2024

If you think it's useful, we could add it and bump major version. And by "we", I mean PRs welcome. 🤓 But I don't suffer from Hauptversionserhöhungsangst – people want SemVer, they get SemVer.

@jamesbraza
Copy link
Contributor Author

I vote check-sdist get installed/used internally here, I think the value of a one-stop shop GitHub action with less configuration/typing for the normal case outweighs edge case configuration

@hynek
Copy link
Owner

hynek commented Oct 14, 2024

I've wondered about adding it. Check-sdist checks to see if every file in git is included in the SDist. (It's like check-manifest, but for any backend.) It's not very useful for hatch or scikit-build-core projects, as they are based on the git contents too (slightly different, so not useless), but it's really useful for flit-core projects and other backends that don't use git for the file list (like setuptools).

JFTR: it's also useful for hatchling that only kinda does git-based packaging. In fact, I started this project because I almost shipped a .mypy_cache once: pypa/hatch#304

This is an even bigger foot-gun than not caring about git at all, since it gives a false sense of security.

@henryiii
Copy link
Contributor

Does it not do recursive gitignores? Scikit-build-core does. Yes, you are correct, both of those do .gitignore based packages, that's why I said "slightly different, so not useless". I'm experimenting with an idea to reduce the amount of configuration needed for a few common backends.

@henryiii
Copy link
Contributor

This is what I was thinking: henryiii/check-sdist#66. That would reduce false positives I think.

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

No branches or pull requests

3 participants