docs(workflow run): add cleanup marker with explanation on future changes

babakks · babakks · commit c47a10e58364 · 2026-02-16T22:02:18.000Z
Signed-off-by: Babak K. Shandiz &lt;babakks@github.com&gt;
diff --git a/pkg/cmd/workflow/run/run.go b/pkg/cmd/workflow/run/run.go
@@ -327,6 +327,10 @@ func runRun(opts *RunOptions) error {
 		"inputs": providedInputs,
 	}
 
+	// TODO workflowDispatchRunDetailsCleanup
+	// We will have to always set the `return_run_details` field to true, unless
+	// we opt into the the new REST API version, which will probably return the
+	// details by default.
 	if returnRunDetailsSupported {
 		requestBody["return_run_details"] = true
 	}

Original file line number	Diff line number	Diff line change
`@@ -327,6 +327,10 @@ func runRun(opts *RunOptions) error {`
`327`	`327`	`"inputs": providedInputs,`
`328`	`328`	`}`
`329`	`329`
	`330`	`+ // TODO workflowDispatchRunDetailsCleanup`
	`331`	+ // We will have to always set the `return_run_details` field to true, unless
	`332`	`+ // we opt into the the new REST API version, which will probably return the`
	`333`	`+ // details by default.`
`330`	`334`	`if returnRunDetailsSupported {`
`331`	`335`	`requestBody["return_run_details"] = true`
`332`	`336`	`}`