Prove the built wheel still has its dataset in it - #13
Merged
Merged
Conversation
The dataset ships as package data. If that ever stops working, the wheel still builds, passes twine, uploads and installs -- it just contains no addresses, and the library is inert. Nothing in CI would notice: the test suite runs against the source tree, where the file is on disk whether or not packaging would have included it. I checked rather than assumed. A wheel with the .jsonl removed passes `twine check --strict` without complaint; twine validates metadata, not contents. So CI now installs the built wheel into a venv outside the repo, where there is no source tree to fall back on, and makes it produce an address. Against a stripped wheel that step fails on the missing file, which is the whole point of it. PyPI versions are immutable, so the alternative to catching this before a release is not catching it at all. Also: cache pip across jobs, and cancel a superseded run rather than letting two five-version matrices race.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe CI workflow now cancels superseded runs, caches pip dependencies for lint and test jobs, and adds a package job that builds, validates, installs, and smoke-tests the wheel. ChangesCI and package validation
Estimated code review effort: 2 (Simple) | ~10 minutes Sequence Diagram(s)sequenceDiagram
participant PackageJob
participant BuildTools
participant Twine
participant TemporaryVenv
PackageJob->>BuildTools: build wheel
PackageJob->>Twine: run strict package check
PackageJob->>TemporaryVenv: install built wheel
TemporaryVenv-->>PackageJob: assert shipped dataset is non-empty
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The dataset ships as package data. If that ever stops working, the wheel still builds, passes twine, uploads and installs -- it just contains no addresses, and the library is inert. Nothing in CI would notice: the test suite runs against the source tree, where the file is on disk whether or not packaging would have included it.
I checked rather than assumed. A wheel with the .jsonl removed passes
twine check --strictwithout complaint; twine validates metadata, not contents. So CI now installs the built wheel into a venv outside the repo, where there is no source tree to fall back on, and makes it produce an address. Against a stripped wheel that step fails on the missing file, which is the whole point of it.PyPI versions are immutable, so the alternative to catching this before a release is not catching it at all.
Also: cache pip across jobs, and cancel a superseded run rather than letting two five-version matrices race.
Summary by CodeRabbit