temporalio / temporalio/cli

[Feature Request] Provide more useful basic information in default output for `workflow show` command.

Open
#612 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Go
Stars
379
Forks
103
Avg merge
2d 11h
Merged PRs (30d)
23

Description

Some ideas:

  ID          Time                          Type                                                                Details
   1  2024-07-01T17:43:22Z  WorkflowExecutionStarted                            MyWorkflowType
   2  2024-07-01T17:43:22Z  WorkflowTaskScheduled                               MyTaskQueue?
   3  2024-07-01T17:43:34Z  WorkflowTaskStarted                                    ${schedule to start time}
   4  2024-07-01T17:43:34Z  WorkflowTaskCompleted                              ${processing time}
   5  2024-07-01T17:43:34Z  StartChildWorkflowExecutionInitiated         MyChildWorkflowType
   6  2024-07-01T17:43:34Z  ChildWorkflowExecutionStarted
   7  2024-07-01T17:43:34Z  WorkflowTaskScheduled
   8  2024-07-01T17:43:34Z  WorkflowTaskStarted
   9  2024-07-01T17:43:34Z  WorkflowTaskCompleted
  10  2024-07-01T17:46:48Z  ChildWorkflowExecutionCompleted           ${total time}
...
  • For timer we can show the duration, and in the future maybe the summary field.
  • For activity show the activity type.
  • Show signal / update names

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the workflow show command and trace how workflow history events are rendered in the default output. Review the event types listed in the issue, then define the displayed details for timers, activities, signals, updates, and child workflows; done means the default table provides the requested basic information.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.