Skip to content

CLI: commands to create and edit workflows #1246

@josephjclark

Description

@josephjclark

There's quite a lot of local boiler plate needed to add, rename or remove workflows and steps

it would be nice to have CLI helpers for this:

openfn workflow add <workflow-name>
openfn workflow rename <old-name> <new-name>
openfn workflow remove <workflow-name>

By name I think I mean id, not really name. It might be nice to accept a name as a quoted string and slugify it. So I can do openfn workflow add "Fetch from DHIS2 😃" and it'll just work like it would in the app

There's a similar command for steps:

openfn step add <workflow-name> <step-name>
openfn step rename <workflow-name> <step-name> <new-name>
openfn step remove <workflow-name> <step-name>
openfn step link <from-step> <to-step>

The step API is pretty heavyweight as you need to specify the workflow. If there's only one workflow you could default it. Maybe it's more like

openfn step add <step-name> -w <workflow-name> 

Now workflow name is optional (but it's usually needed)

I'm not sure if this should be namespaced under project. Probably the logic lives in project. Maybe like checkout, it's a project function but we have a top level alias

The CLI helpers would only modify the local file system - they should not write back to the project.yaml files or anything

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    DevX Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions