doc(console): Adds add_renderable example and apply-live demo#15
Merged
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #15 +/- ##
==========================================
+ Coverage 85.56% 85.61% +0.04%
==========================================
Files 20 21 +1
Lines 1878 2037 +159
==========================================
+ Hits 1607 1744 +137
- Misses 271 293 +22 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…ist[ShellRunCallbackT] | None, and removed the now-unused ShellRunEventT import. Pyright passes cleanly.
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.
Summary
add_renderableatdocs/examples/console/add_renderable.md: dynamic__rich_console__renderables, wiring into the live region, and CI vs TTY rendering notes.examples/apply_live/, a standalone Typer demo (no tfdo import) that streamsterraform apply -json -auto-approvethrough ask-shellmessage_callbackswithskip_progress_output=True.time_sleepresources (~20s fresh apply) and a minimal NDJSON stream handler usingadd_renderablelocally pluslogger.infoheartbeats wheninteractive_shell()is false.examples_include), mkdocs nav, andask_shell/test_docs.py.just apply-liveand a CI job that runs checkout, setup, Terraform 1.12.1 (terraform_wrapper: false), andjust apply-livewithCI=true.apply-live demo
Run locally from
code/ask-shell/:just apply-live CI=true just apply-live # heartbeat log lines instead of live panelThe CLI always runs
terraform init -input=falsebefore apply so a clean checkout works without a separate init step. Re-run after the first apply is a no-op; reset withterraform destroy -auto-approveinexamples/apply_live/workspace/.Test plan
uv run pytest ask_shell/test_docs.py -k add_renderableuv run pytest examples/apply_live/stream_handler_test.pyjust pre-commit-askCI=true just apply-live(local)apply-livejob on GitHub Actions