Skip to content

Commit 94f7f9c

Browse files
committed
fix: label Orkes-only commands; print workflow output by default with --sync
- api-gateway: Short/Long now say "Orkes Conductor only" upfront - worker remote/list-remote: add explicit Orkes-only warning to Long text - workflow start --sync: print run.Output by default; add --full flag for complete WorkflowRun JSON Closes conductor-oss/getting-started#20, conductor-oss/getting-started#11
1 parent 8c2c954 commit 94f7f9c

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

cmd/api_gateway.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ const (
3434
var (
3535
apiGatewayCmd = &cobra.Command{
3636
Use: "api-gateway",
37-
Short: "API Gateway management commands",
38-
Long: "Manage API Gateway services, routes, and authentication configurations.",
37+
Short: "API Gateway management commands (Orkes Conductor only)",
38+
Long: "Manage API Gateway services, routes, and authentication configurations.\n\n⚠️ Requires Orkes Conductor. These commands are not available in OSS Conductor.",
3939
GroupID: "conductor",
4040
}
4141

cmd/worker.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,9 @@ Exit codes:
9797

9898
workerRemoteCmd = &cobra.Command{
9999
Use: "remote",
100-
Short: "Run a worker from the job-runner registry (EXPERIMENTAL)",
100+
Short: "Run a worker from the job-runner registry (EXPERIMENTAL, Orkes Conductor only)",
101101
Long: `⚠️ EXPERIMENTAL FEATURE - Download and execute a worker from the Orkes Conductor job-runner.
102+
⚠️ Requires Orkes Conductor. Not available in OSS Conductor.
102103
103104
The worker is downloaded from the configured Conductor server and cached locally for
104105
subsequent runs. Use --refresh to force re-download from the registry.
@@ -115,8 +116,9 @@ The worker runs in continuous mode, polling for tasks and executing them in para
115116

116117
workerListRemoteCmd = &cobra.Command{
117118
Use: "list-remote",
118-
Short: "List available workers in the job-runner registry (EXPERIMENTAL)",
119-
Long: `⚠️ EXPERIMENTAL FEATURE - List all available workers in the Orkes Conductor job-runner registry.`,
119+
Short: "List available workers in the job-runner registry (EXPERIMENTAL, Orkes Conductor only)",
120+
Long: `⚠️ EXPERIMENTAL FEATURE - List all available workers in the Orkes Conductor job-runner registry.
121+
⚠️ Requires Orkes Conductor. Not available in OSS Conductor.`,
120122
RunE: listRemoteWorkers,
121123
SilenceUsage: true,
122124
Example: "conductor worker list-remote\nconductor worker list-remote --namespace production",

cmd/workflow.go

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1082,7 +1082,14 @@ func startWorkflow(cmd *cobra.Command, args []string) error {
10821082
return parseAPIError(execErr, "Failed to start workflow")
10831083
}
10841084

1085-
data, jsonError := json.MarshalIndent(run, "", " ")
1085+
full, _ := cmd.Flags().GetBool("full")
1086+
var printTarget interface{}
1087+
if full {
1088+
printTarget = run
1089+
} else {
1090+
printTarget = run.Output
1091+
}
1092+
data, jsonError := json.MarshalIndent(printTarget, "", " ")
10861093
if jsonError != nil {
10871094
return jsonError
10881095
}
@@ -1434,6 +1441,7 @@ func init() {
14341441
startExecutionCmd.Flags().StringP("correlation", "", "", "Correlation ID")
14351442
startExecutionCmd.Flags().Bool("sync", false, "Execute synchronously and wait for completion")
14361443
startExecutionCmd.Flags().StringP("wait-until", "u", "", "Wait until task completes (only with --sync)")
1444+
startExecutionCmd.Flags().Bool("full", false, "Print full workflow run JSON instead of just the output (only with --sync)")
14371445
startExecutionCmd.MarkFlagsMutuallyExclusive("input", "file")
14381446

14391447
getExecutionCmd.Flags().BoolP("complete", "c", false, "Include complete details")

0 commit comments

Comments
 (0)