Skip to content

Command: workflowRuns trigger#63

Merged
andrewjensen merged 27 commits into
mainfrom
adj/cmd/workflowRuns-trigger
May 6, 2026
Merged

Command: workflowRuns trigger#63
andrewjensen merged 27 commits into
mainfrom
adj/cmd/workflowRuns-trigger

Conversation

@andrewjensen
Copy link
Copy Markdown
Collaborator

@andrewjensen andrewjensen commented Apr 29, 2026

This defines the dx workflowRuns trigger command.

Help text:

Usage: dx workflowRuns trigger [options] <workflow-identifier>

Trigger a Self-service workflow run and wait until it succeeds or fails. If the workflow requires approval, this command will submit a request and notify
approvers.

Arguments:
  workflow-identifier           Workflow identifier (from dx workflows list)

Options:
  --entity <identifier>         Catalog entity identifier (required for entity-scoped workflows)
  --param <key=value>           Workflow parameter value (repeatable). Value after the first '=' is kept verbatim (default: [])
  --notify-approvers <boolean>  For workflows that require approval, send a message to each approver requesting review
  -h, --help                    display help for command

Examples:
  Trigger a global workflow and wait for completion:
    dx workflowRuns trigger my-global-workflow
  Trigger with an entity and parameters:
    dx workflowRuns trigger provision-db --entity acme-api --param size=small --param "greeting=hello world"
  Trigger with machine-readable output:
    dx workflowRuns trigger my-workflow --json --entity svc-1 --param count=3
  Request approval to trigger a workflow but do not notify approvers:
    dx workflowRuns trigger workflow-requiring-approval --notify-approvers false

Depends on #69. Note that this PR originally had all the other commands but we split off the other PR to define info and the event commands.

@andrewjensen andrewjensen changed the title Command: workflowRuns trigger workflowRuns commands May 6, 2026
@andrewjensen andrewjensen marked this pull request as ready for review May 6, 2026 18:12
Copy link
Copy Markdown

@BigGig17 BigGig17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good, I don't actually have a lot of concerns around event rendering and approval language for the events per se, however IU do have concerns around the UI Triggering language and how it implies that all triggers are "triggers" and not "requests to trigger" which they sometimes can be.

Additionally, I would like to see the trigger PR split from the rest as I think that's a relatively delicate CLI Item here that I think would value from it's own PR.

Lastly, should we add some in code comments at the top of some of these files to give more of a description of how we intend for them to work or link to the DX Docs for the relevant API Methods perhaps? WDYT?

Also the verify checks seem to be blocking as well 😅

Comment thread src/commands/workflowRuns/trigger.ts
Comment thread src/commands/workflowRuns/trigger.ts Outdated
Comment thread src/commands/workflowRuns/info.ts Outdated
@andrewjensen andrewjensen changed the title workflowRuns commands Command: workflowRuns trigger May 6, 2026
Copy link
Copy Markdown

@BigGig17 BigGig17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more minor tweak but otherwise I like it!

Comment thread src/commands/workflowRuns/trigger.ts Outdated
@andrewjensen andrewjensen merged commit b955a61 into main May 6, 2026
3 checks passed
@andrewjensen andrewjensen deleted the adj/cmd/workflowRuns-trigger branch May 6, 2026 21:50
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.

2 participants