Skip to content

Commit 9dd94ef

Browse files
docs(dataform): update descriptions (#47)
* docs(dataform): update descriptions * Apply suggestion from @wrussell1999 Co-authored-by: Will Russell <wrussell@kestra.io> * Apply suggestion from @wrussell1999 Co-authored-by: Will Russell <wrussell@kestra.io> * Apply suggestion from @wrussell1999 Co-authored-by: Will Russell <wrussell@kestra.io> * Apply suggestion from @wrussell1999 Co-authored-by: Will Russell <wrussell@kestra.io> --------- Co-authored-by: Will Russell <wrussell@kestra.io>
1 parent 1ab74fa commit 9dd94ef

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

src/main/java/io/kestra/plugin/dataform/cli/DataformCLI.java

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
@Getter
3131
@NoArgsConstructor
3232
@Schema(
33-
title = "Orchestrate a Dataform project with CLI commands."
33+
title = "Run Dataform CLI commands in Kestra",
34+
description = "Executes Dataform CLI commands through the configured task runner. Defaults to a container run with image `dataformco/dataform:latest`; override with taskRunner or containerImage. Supports setup commands, custom env, and namespace/input/output files."
3435
)
3536
@Plugin(
3637
examples = {
@@ -74,18 +75,21 @@ public class DataformCLI extends Task implements RunnableTask<ScriptOutput>, Nam
7475
private static final String DEFAULT_IMAGE = "dataformco/dataform:latest";
7576

7677
@Schema(
77-
title = "The commands to run before main list of commands"
78+
title = "Run setup commands first",
79+
description = "Optional commands executed before the main commands in the same working directory and environment."
7880
)
7981
protected Property<List<String>> beforeCommands;
8082

8183
@Schema(
82-
title = "The commands to run"
84+
title = "Run Dataform CLI commands",
85+
description = "Required commands executed sequentially with `/bin/sh -c`; include your Dataform CLI actions here."
8386
)
8487
@NotNull
8588
protected Property<List<String>> commands;
8689

8790
@Schema(
88-
title = "Additional environment variables for the current process."
91+
title = "Additional environment variables",
92+
description = "Key-value map merged into the process environment; supports templated values; defaults to an empty map."
8993
)
9094
@PluginProperty(
9195
additionalProperties = String.class,
@@ -94,22 +98,26 @@ public class DataformCLI extends Task implements RunnableTask<ScriptOutput>, Nam
9498
protected Map<String, String> env;
9599

96100
@Schema(
97-
title = "Deprecated, use 'taskRunner' instead"
101+
title = "Deprecated Docker runner settings",
102+
description = "Legacy DockerOptions field; prefer taskRunner. If provided without image or entryPoint, defaults to `dataformco/dataform:latest` and an empty entrypoint."
98103
)
99104
@PluginProperty
100105
@Deprecated
101106
private DockerOptions docker;
102107

103108
@Schema(
104-
title = "The task runner to use.",
105-
description = "Task runners are provided by plugins, each have their own properties."
109+
title = "Select task runner implementation",
110+
description = "Defaults to the Docker runner; plugin task runners may expose their own properties."
106111
)
107112
@PluginProperty
108113
@Builder.Default
109114
@Valid
110115
private TaskRunner<?> taskRunner = Docker.instance();
111116

112-
@Schema(title = "The task runner container image, only used if the task runner is container-based.")
117+
@Schema(
118+
title = "Container image for task runner",
119+
description = "Used only for container-based task runners; defaults to `dataformco/dataform:latest`."
120+
)
113121
@Builder.Default
114122
private Property<String> containerImage = Property.ofValue(DEFAULT_IMAGE);
115123

0 commit comments

Comments
 (0)