fix(build): use an sdist allowlist so the zarr sdist stops shipping subpackages - #4261
Merged
d-v-b merged 3 commits intoAug 13, 2026
Merged
Conversation
github-actions
Bot
added
the
needs release notes
7 tasks
d-v-b
marked this pull request as ready for review
August 13, 2026 10:36
Contributor
Author
I will try to address that concern in this PR with some new CI jobs. |
github-actions
Bot
removed
the
needs release notes
…ubpackages The root sdist config was a blocklist naming /.github, /bench and /docs, so every release shipped whatever else happened to sit in the repository root. That included the whole packages/ tree — the zarr-indexing, zarr-metadata and zarr-http-server sources, which are released as their own distributions — plus ci/, design/, towncrier fragments and other repo furniture. 2.9M of the 1.4M sdist was other people's packages. Replace it with an explicit allowlist, matching what packages/zarr-indexing and packages/zarr-metadata already do. Including /docs also fixes a second problem: tests/test_docs.py walks docs/ and testpaths collects docs/user-guide, so with docs/ excluded the shipped test suite died at collection with 'Not a file or directory'. tests/test_docs.py now runs green from an unpacked sdist (61 passed, 2 skipped), and full collection finds 7581 tests with no errors. Assisted-by: ClaudeCode:claude-opus-5
d-v-b
force-pushed
the
claude/zarr-sdist-allowlist-414698
branch
from
August 13, 2026 11:08
58cfed9 to
8881b25
Compare
This was referenced Aug 13, 2026
Drop the narration of the blocklist this replaced -- that history lives in git -- and keep only the durable rationale and the reason each entry is on the list. Assisted-by: ClaudeCode:claude-opus-5
Contributor
Author
|
I'm self-merging this, because IMO it's a release blocker and we can always revisit the particulars later. |
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
1 participant
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.
Summary
This is an AI-written PR that changes our sdist contents from blocklist-defined to allowlist-defined. That keeps new stuff out by default, which is easier when we are adding new subpackages. Without changing something we are bundling the contents of
packages/in the sdist, which is not correct. If we add each subpackage to the blocklist, we have an unsafe default. Better to have the safe default, where new subpackages don't need to be explicitly excluded.This change does raise the possibility that we add a new file or path that is required for sdist consumers like conda, but we forget to add it to the allowlist. We should consider addressing this in CI with some kind of "conda can consume this" check, and/or normalize release candidate releases (not sure if conda forge picks those up).
This was written by claude, and the original PR is here: d-v-b#289
Author attestation
TODO
docs/user-guide/*.mdchanges/