Skip to content
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.

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

Add workflow update start and workflow update execute subcommands #642

Merged
merged 5 commits into from
Aug 29, 2024

Conversation

dandavison
Copy link
Contributor

@dandavison dandavison commented Aug 21, 2024

Closes #597

This PR changes the CLI API so that workflow update is not itself a leaf command, but has two leaf subcommands: start and execute. Previously, workflow update had the behavior of what is now workflow update, so this is a breaking change to the not-yet-GA workflow update feature.

workflow update start will output the update ID. In order to block and fetch the result of the update, users can do workflow update execute passing the started update ID. See #647 for relevant plans to evolve the CLI update API, creating a new way to fetch the result.

How this was tested

  • Manually against a Python sample
  • PR adds integration tests

@dandavison dandavison force-pushed the 597-workflow-update branch 3 times, most recently from 402942a to 0ea3afe Compare August 28, 2024 03:13
@dandavison dandavison marked this pull request as ready for review August 28, 2024 03:21
@dandavison dandavison changed the title Support workflow update start, create workflow update execute subcommand Add workflow update start, and workflow update execute subcommands Aug 28, 2024
@dandavison dandavison changed the title Add workflow update start, and workflow update execute subcommands Add workflow update start and workflow update execute subcommands Aug 28, 2024
### temporal workflow update execute: Send an Update and wait for it to complete
Send a message to a Workflow Execution to invoke an Update handler, and wait for
the update to complete or fail. You can also use this to wait for an existing
update to complete, by submitting an existing update ID.
Copy link
Contributor Author

@dandavison dandavison Aug 28, 2024

Choose a reason for hiding this comment

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

The last sentence will be changed when #647 is implemented.

temporalcli/commandsmd/commands.md Outdated Show resolved Hide resolved
temporalcli/commands.workflow.go Show resolved Hide resolved
@dandavison dandavison merged commit 7083a42 into main Aug 29, 2024
7 checks passed
@dandavison dandavison deleted the 597-workflow-update branch August 29, 2024 22:57
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.

[Feature Request] Support update start in addition to update execute
2 participants