Implement workflow terminate command
#436
Conversation
Also ensure terminate with a workflow id works without a reason specified
Also use an options struct for workflowExecOrBatch
| @@ -338,7 +338,7 @@ Includes options set for [payload input](#options-set-for-payload-input). | |||
| * `--run-id`, `-r` (string) - Run Id. Cannot be set when query is set. | |||
| * `--query`, `-q` (string) - Start a batch to Signal Workflow Executions with given List Filter. Either this or | |||
| Workflow Id must be set. | |||
| * `--reason` (string) - Reason to perform batch. Only allowed if query is present unless the command specifies otherwise. | |||
| * `--reason` (string) - Reason to perform batch. Only allowed if query is present unless the command specifies otherwise. Defaults to message with the current user's name. | |||
There was a problem hiding this comment.
You're looking at the help for workflow signal rather than workflow terminate. That command only allows a reason to be specified when invoked in batch mode. If you check the options for workflow terminate you'll see I updated it there already:
* `--reason` (string) - Reason to terminate this workflow. Defaults to message with the current user's name.
| * `--workflow-id`, `-w` (string) - Workflow Id. Either this or query must be set. | ||
| * `--run-id`, `-r` (string) - Run Id. Cannot be set when query is set. | ||
| * `--query`, `-q` (string) - Start a batch to terminate Workflow Executions with given List Filter. Either this or Workflow Id must be set. | ||
| * `--reason` (string) - Reason for termination. Defaults to message with the current user's name. | ||
| * `--yes`, `-y` (bool) - Confirm prompt to perform batch. Only allowed if query is present. |
There was a problem hiding this comment.
| * `--workflow-id`, `-w` (string) - Workflow Id. Either this or query must be set. | |
| * `--run-id`, `-r` (string) - Run Id. Cannot be set when query is set. | |
| * `--query`, `-q` (string) - Start a batch to terminate Workflow Executions with given List Filter. Either this or Workflow Id must be set. | |
| * `--reason` (string) - Reason for termination. Defaults to message with the current user's name. | |
| * `--yes`, `-y` (bool) - Confirm prompt to perform batch. Only allowed if query is present. | |
| Includes options set for [single workflow or batch](#options-set-for-single-workflow-or-batch). |
Or are you making this a completely separate options set just because of the English description of reason?
There was a problem hiding this comment.
Note that #options-set-for-single-workflow-or-batch mentions signal and reason is applied only to batch.
There was a problem hiding this comment.
Here's the discussion Roey and I had about this @cretz: #436 (comment)
There was a problem hiding this comment.
We can make docs more generic if we need to, but I have no problem copy/pasting just for docs-only reasons if we have to like here.
| namespace string, | ||
| cl client.Client, | ||
| overrides singleOrBatchOverrides, |
There was a problem hiding this comment.
Probably can toss all of this in a single struct instead of keeping overrides separate, but no biggie
What was changed
I implemented
temporal workflow terminate, which should behave the same as in the existing CLI except for the same caveats/improvements as in #432.I extended the existing
SingleWorkflowOrBatchfunctions to allow a command to opt-in to supplying a reason alongside a workflow id as terminate allows for this.