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
Copy file name to clipboardExpand all lines: docs/targets/script/meta.md
+15-24Lines changed: 15 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,71 +6,62 @@ This page provides a walkthrough of the `meta.yaml` file.
6
6
7
7
-**alias** (`string`)
8
8
9
-
-Alias of the script, which can be used instead of tags when running a script.
9
+
Alias of the script, which can be used instead of tags when running a script.
10
10
11
11
-**uid** (`string`)
12
12
13
-
- Unique identifier for individual scripts.
14
-
15
-
- Can be used instead of tags when running a script.
13
+
Unique identifier for individual scripts. Can be used instead of tags when running a script.
16
14
17
15
-**automation_alias** (`string`)
18
16
19
-
-Alias specific to script automation.
17
+
Alias specific to script automation.
20
18
21
19
-**automation_uid** (`string`)
22
20
23
-
-Unique identifier for script automation.
21
+
Unique identifier for script automation.
24
22
25
23
-**category** (`string`)
26
24
27
-
-Defines the script category.
25
+
Defines the script category.
28
26
29
27
-**tags** (`list of strings`)
30
28
31
-
-List of tags users can specify to run the script.
29
+
List of tags users can specify to run the script.
32
30
33
31
-**default_env** (`dictionary` with `string` values)
34
32
35
-
- Contains key-value pairs representing environment variables and their default values for a script.
36
-
37
-
- These default values are overridden if the same environment variable is set in script files or inherited from a parent script.
33
+
Contains key-value pairs representing environment variables and their default values for a script. These default values are overridden if the same environment variable is set in script files or inherited from a parent script.
38
34
39
35
-**env** (`dictionary` with `string` values)
40
36
41
-
-Defines environment variables and their corresponding values.
37
+
Defines environment variables and their corresponding values.
42
38
43
39
-**input_mapping** (`dictionary` with `string` values)
44
40
45
-
- Maps input flags related to a script to corresponding environment variables.
46
-
47
-
- Only keys specified under `input_mapping` in `meta.yaml` are mapped to environment variables.
41
+
Maps input flags related to a script to corresponding environment variables. Only keys specified under `input_mapping` in `meta.yaml` are mapped to environment variables.
48
42
49
43
-**env_key_mapping** (`dictionary` with `string` values)
50
44
51
-
-Maps one environment key to another.
45
+
Maps one environment key to another just for the `run` script execution.
52
46
53
47
-**new_env_keys** (`list of strings`)
54
48
55
-
-Specifies environment keys that should be passed to a parent script if this script is used as a dependency.
49
+
Specifies environment keys that should be passed to a parent script if this script is used as a dependency.
56
50
57
51
-**new_state_keys** (`list of strings`)
58
52
59
-
-Specifies state keys that should be passed to a parent script when used as a dependency.
53
+
Specifies state keys that should be passed to a parent script when used as a dependency.
60
54
61
55
-**add_deps_recursive** (`dictionary`)
62
56
63
-
-Customizes recursive dependencies with nested `tags` and other attributes.
57
+
Customizes recursive dependencies with nested `tags` and other attributes.
64
58
65
59
### Dependencies
66
60
67
-
Dependencies in a script are specified as a list of dictionaries.
68
-
69
-
- Each dictionary can contain:
61
+
Dependencies in a script are specified as a list of dictionaries. Each dictionary can contain:
70
62
71
63
- **tags**
72
-
73
-
- Comma separated list of tags to identify a dependent script
64
+
Comma separated list of tags to identify a dependent script
0 commit comments