temporalio/cli

[CLI Refresh] Consistent payload input options across all commands

Open

#446 opened on Feb 12, 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

Workflow input payload supports options including

  -i, --input stringArray              Input value (default JSON unless --input-payload-meta is non-JSON encoding). Can be given multiple times for multiple arguments. Cannot be combined with --input-file.
      --input-base64                   If set, assumes --input or --input-file are base64 encoded and attempts to decode.
      --input-file stringArray         Reads a file as the input (JSON by default unless --input-payload-meta is non-JSON encoding). Can be given multiple times for multiple arguments. Cannot be combined with --input.
      --input-meta stringArray         Metadata for the input payload. Expected as key=value. If key is encoding, overrides the default of json/plain.

Extend this to make payload functionality uniform across other payloads inputs such as Activity result, Activity failure detail.

Ref https://github.com/temporalio/cli/pull/445#discussion_r1486903085

Contributor guide

Research direction
Review the existing payload input implementation in CLI PR #445 and extend it to Activity result and failure detail commands. Ensure consistent flag handling and add tests.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50