temporalio/cli

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

Open

#612 opened on Jul 2, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (96 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (370 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Inspect the current output generation for the `workflow show` command in the Temporal CLI source code, identify where event type names and details are formatted, and add additional columns for time, type, and details as described in the issue.
Tech stack
go
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65