Skip to content

feat(scaffold): add __deployment__.py deployment manifest stub#4

Merged
bjoaquinc merged 1 commit into
develfrom
feat/scaffold-deployment-manifest
Jun 30, 2026
Merged

feat(scaffold): add __deployment__.py deployment manifest stub#4
bjoaquinc merged 1 commit into
develfrom
feat/scaffold-deployment-manifest

Conversation

@bjoaquinc

Copy link
Copy Markdown
Collaborator

Summary

Scaffolds an empty __deployment__.py into the bundled minimal workspace. dlt's CLI discovers this module by default (dlthub deploy syncs it to the dltHub Platform) — it's the manifest where you import the pipelines and notebooks you want to deploy and list them in __all__. Shipping it empty (with a one-line guidance comment) makes a fresh workspace deploy-ready and pre-empts the "no manifest found (create __deployment__.py)" prompt.

Mirrors the minimal manifest shape used in dlthub-start:

"""Deployment manifest — import the pipelines and notebooks you want to deploy and list them in __all__."""

# from pipeline import my_pipeline
# from notebook import my_notebook

__all__: list[str] = []

The import stays commented because the minimal scaffold ships no pipeline.py/notebook.py yet, so an active import would error.

Changes

  • New src/dlthub_init/scaffolds/minimal_workspace/__deployment__.py (auto-discovered + copied by enumerate_payload; tracked in the user's workspace — scaffold .gitignore only ignores *.py[codz]).
  • tests/test_scaffold.py: added the file to the pinned EXPECTED set.
  • CHANGELOG entry under [Unreleased] → Added.

Testing

  • make test ✅ (103 passed)

🤖 Generated with Claude Code

Scaffolds an empty __deployment__.py into the minimal workspace. dlt
discovers this module by default ('dlthub deploy'); it's where you import
the pipelines and notebooks you want to deploy and list them in __all__.
Ships empty with brief guidance so a fresh workspace is deploy-ready.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@bjoaquinc
bjoaquinc merged commit 7dc3d92 into devel Jun 30, 2026
4 checks passed
@bjoaquinc
bjoaquinc deleted the feat/scaffold-deployment-manifest branch June 30, 2026 14:13
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

Successfully merging this pull request may close these issues.

1 participant