You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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>
Copy file name to clipboardExpand all lines: src/main/java/io/kestra/plugin/dataform/cli/DataformCLI.java
+16-8Lines changed: 16 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,8 @@
30
30
@Getter
31
31
@NoArgsConstructor
32
32
@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."
34
35
)
35
36
@Plugin(
36
37
examples = {
@@ -74,18 +75,21 @@ public class DataformCLI extends Task implements RunnableTask<ScriptOutput>, Nam
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."
78
80
)
79
81
protectedProperty<List<String>> beforeCommands;
80
82
81
83
@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."
83
86
)
84
87
@NotNull
85
88
protectedProperty<List<String>> commands;
86
89
87
90
@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."
89
93
)
90
94
@PluginProperty(
91
95
additionalProperties = String.class,
@@ -94,22 +98,26 @@ public class DataformCLI extends Task implements RunnableTask<ScriptOutput>, Nam
94
98
protectedMap<String, String> env;
95
99
96
100
@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."
98
103
)
99
104
@PluginProperty
100
105
@Deprecated
101
106
privateDockerOptionsdocker;
102
107
103
108
@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."
0 commit comments