Skip to content

docs: correct built-in workflow step source paths #5059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mnriem merged 1 commit into from
Oct 22, 2026
+2 −2
Merged

docs: correct built-in workflow step source paths #5059

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions design/workflow-step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ see [Workflows](../docs/reference/workflows.md).

| Route | Source | Registration |
|---|---|---|
| Built-in | `src/specify_cli/workflows/steps/<package>/__init__.py` | Explicit import and `_register_step()` in `src/specify_cli/workflows/__init__.py` |
| Built-in | `src/specify_cli/workflows/step/<package>/__init__.py` | Explicit import and `_register_step()` in `src/specify_cli/workflows/__init__.py` |
| Installed | Package under `.specify/workflows/steps/<id>/`, containing `step.yml` and `__init__.py` | `load_custom_steps(project_root)` loads a matching `StepBase` subclass at workflow run/resume |

`STEP_REGISTRY` maps each `type_key` to a single step instance. Built-in keys
Expand Down Expand Up @@ -72,7 +72,7 @@ thread-safe, with per-run data in `config` and `context`, not on `self`.

## Adding a step type

1. Implement the step in its own `steps/<package>/` subpackage and register
1. Implement the step in its own `step/<package>/` subpackage and register
it explicitly with a unique `type_key`. For an external package, provide
`step.yml` with a matching `step.type_key` and a matching subclass in
`__init__.py`; catalog discovery alone does not register the code.
Expand Down
Loading