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

Reorder workflow commands #274

Merged
merged 3 commits into from
Jul 7, 2023
Merged

Reorder workflow commands #274

merged 3 commits into from
Jul 7, 2023

Conversation

feedmeapples
Copy link
Contributor

@feedmeapples feedmeapples commented Jun 27, 2023

What was changed

changed workflow commands order

show and trace are now next to each other
update is next to signal
count is at the end now as probably lesser used command

New order:

temporal workflow -h

...

COMMANDS:
   start        Starts a new Workflow Execution.
   execute      Start a new Workflow Execution and prints its progress.
   describe     Show information about a Workflow Execution.
   list         List Workflow Executions based on a Query.
   show         Show Event History for a Workflow Execution.
   trace        Trace progress of a Workflow Execution and its children.
   query        Query a Workflow Execution.
   stack        Query a Workflow Execution with __stack_trace as the query type.
   signal       Signal Workflow Execution by Id or List Filter.
   update       Updates a running workflow synchronously.
   cancel       Cancel a Workflow Execution.
   terminate    Terminate Workflow Execution by ID or List Filter.
   delete       Deletes a Workflow Execution.
   reset        Resets a Workflow Execution by Event ID or reset type.
   reset-batch  Reset a batch of Workflow Executions...
   count        Count Workflow Executions (requires ElasticSearch to be enabled).
   help, h      Shows a list of commands or help for one command

was:

start        Starts a new Workflow Execution.
   execute      Start a new Workflow Execution and prints its progress.
   describe     Show information about a Workflow Execution.
   list         List Workflow Executions based on a Query.
   show         Show Event History for a Workflow Execution.
   query        Query a Workflow Execution.
   stack        Query a Workflow Execution with __stack_trace as the query type.
   signal       Signal Workflow Execution by Id or List Filter.
   count        Count Workflow Executions (requires ElasticSearch to be enabled).
   cancel       Cancel a Workflow Execution.
   terminate    Terminate Workflow Execution by ID or List Filter.
   delete       Deletes a Workflow Execution.
   reset        Resets a Workflow Execution by Event ID or reset type.
   reset-batch  Reset a batch of Workflow Executions by..
   trace        Trace progress of a Workflow Execution and its children.
   update       Updates a running workflow synchronously.
   help, h      Shows a list of commands or help for one command

Why?

UX, imo easier to comprehend the options

Checklist

  1. Closes

  2. How was this tested:

ci

  1. Any docs updates needed?

Copy link
Contributor

@lorensr lorensr left a comment

Choose a reason for hiding this comment

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

👍 I like! Could also maybe put list first, so describe/show/trace/etc are all about a single WE

@feedmeapples feedmeapples merged commit d37f65c into main Jul 7, 2023
15 checks passed
@feedmeapples feedmeapples deleted the reorder-workflow-commands branch July 7, 2023 02:02
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.

None yet

2 participants