Include tests and examples in sub-package source distributions#1618
Merged
Conversation
skrawcz
force-pushed
the
stefan/add-tests-examples-to-sdist
branch
from
2df93a8 to
78e4829
Compare
Dev-iL
approved these changes
Jun 1, 2026
Collaborator
Dev-iL
left a comment
Dev-iL
left a comment
There was a problem hiding this comment.
The PR change is verified:
- tests are present in all 4 sdists.
- The
contribpackage has 4 test files co-located inside the package (not a top-leveltests/dir), which is correct given how that package is structured.
jernejfrank
reviewed
Jun 1, 2026
Contributor
jernejfrank
left a comment
jernejfrank
left a comment
There was a problem hiding this comment.
Great, there's this one script that seems like we need to include in the source in the contrib package. Otherwise, rest looks all good!
skrawcz
force-pushed
the
stefan/add-tests-examples-to-sdist
branch
from
b026cda to
792a69a
Compare
skrawcz
force-pushed
the
stefan/add-tests-examples-to-sdist
branch
from
792a69a to
3bcf4a9
Compare
Per Apache release policy, tests should be included in the sdist so voters can build from source and run tests to validate. - ui/sdk: removed tests/** from exclude, added to include - dev_tools/language_server: same - contrib: removed tests/** from exclude (tests live inside the package) - ui/backend: already includes tests/** (no change needed)
- Add prerequisite check for gpg, java, flit, uv, svn at script start (fails early with clear error instead of cryptic flit-not-found) - Fix contrib verify: cd to /tmp before running python imports to avoid CWD shadowing installed hamilton package with local repo directory
Add test_sdist.py for ui/sdk, dev_tools/language_server, and contrib that assert pyproject.toml [tool.flit.sdist] configuration: - tests/** is in include (sdk, lsp) or not in exclude (contrib) - examples/** is in include (sdk, contrib) - scripts/** is in include (contrib) — addresses reviewer feedback - Binary files (*.parquet, *.pkl, *.ipynb, *.png) are excluded Also add test_flit_sdist_includes_tests to ui/backend/tests/test_build.py to match the existing pattern for build/** verification. Include contrib/scripts/** in sdist per reviewer request — contains version_check.py used for release validation.
The UI sdist was including hamilton_ui/build/** (compiled JS/CSS from npm build), which would require bundling third-party licenses. Fix: build sdist first (without frontend), then npm build, then wheel. - pyproject.toml: move hamilton_ui/build/** from include to exclude - apache_release_helper.py: split UI build into 3 steps: 1. flit build --format sdist (source-only) 2. npm install + npm run build → copy to hamilton_ui/build/ 3. flit build --format wheel (includes frontend assets) - test_build.py: update assertion to verify build/ is excluded from sdist
skrawcz
force-pushed
the
stefan/add-tests-examples-to-sdist
branch
from
3bcf4a9 to
a60e654
Compare
elijahbenizzy
approved these changes
Jun 7, 2026
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
4 participants
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.
Problem
Vote feedback on RC0: tests and examples were excluded from the source tarballs. Per Apache release policy, voters need to be able to build from source and run tests to validate.
Changes
Tests included in sdist (all 4 packages):
ui/sdk: removedtests/**from exclude, added to includedev_tools/language_server: samecontrib: removedtests/**from excludeui/backend: already included (no change)Examples included via symlinks (SDK + Contrib):
ui/sdk/examples→../../examples/hamilton_ui/contrib/examples→../examples/contrib/Binary files excluded from sdist:
*.parquet,*.pkl,*.ipynb,*.pngexcluded to keep tarballs source-onlyVerification
Built all 4 sdists and confirmed:
Context
Addresses feedback from Jernej Frank's -1 votes on SDK, LSP, and Contrib RC0: