run_notebook¶
Run a notebook and wait for it to finish. A failed run fails the deploy.
Step fragment for a hooks file. Shared step keys are under Steps.
- action: run_notebook
item: <Name>.Notebook # `.Notebook` may be omitted
timeout_seconds: 900
parameters: {seed_rows: 100}
on_error: fail # default: stop the deploy here; `continue` logs it and goes on
Keys¶
| Key | Required | Description |
|---|---|---|
item |
yes | The notebook, <Name> or <Name>.Notebook. |
timeout_seconds |
no | Seconds to wait before failing. Default: fab's. |
parameters |
no | A mapping passed to the run. Each becomes -P name:type=value, the type taken from the YAML value: 100 → int, true → bool, 0.5 → float, anything else string. |
Placeholders produce strings: seed_rows: "{{ variables.seed_rows }}" is passed as a string even when the variable is numeric. Use a YAML number for an int parameter (placeholders).
Behaviour¶
Same as run_pipeline and run_item, with the type defaulted to Notebook.