fix: automate README sync for data-designer package builds #266
+37
−15
Conversation
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
andreatgretel
commented
Jan 29, 2026
andreatgretel
commented
Jan 29, 2026
Contributor
Author
There was a problem hiding this comment.
This might seem a weird location for the file but it's hatchling's default, we could change it
Contributor
There was a problem hiding this comment.
it does kind of weird me out a bit lol
Contributor
Author
There was a problem hiding this comment.
Changed to /dev-tools/hatch_build.py
johnnygreco
approved these changes
Jan 29, 2026
Contributor
Author
|
Checked that this works as intended (delete README > run uv sync, uv build, make commands etc. > README created). Merging |
andreatgretel
force-pushed
the
andreatgretel/fix/uv-sync-or-build-requires-copying-README
branch
from
dc1ddf5 to
2583e4a
Compare
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.
📋 Summary
Adds a hatchling metadata hook to automatically copy the root README.md to the data-designer package during builds, eliminating the need for manual copy steps in the Makefile.
🔄 Changes
✨ Added
packages/data-designer/hatch_build.py- Custom hatch metadata hook that copies README from repository root before hatchling validates metadata🔧 Changed
packages/data-designer/pyproject.toml- Registered the custom metadata hook via[tool.hatch.metadata.hooks.custom]🗑️ Removed
cp README.mdsteps from 6 Makefile targets:install,install-dev,install-dev-notebooks,test-interface-isolated,test-e2e,build-interface🔍 Attention Areas
packages/data-designer/hatch_build.py- This is a metadata hook (not a build hook) because hatchling validates README existence during metadata resolution, before build hooks run. This was tested to work correctly.🤖 Generated with AI