@@ -23,11 +23,12 @@ todo:
23
23
| Control | (todo) | Sub ToDo list |
24
24
| Control | (parallel) | Runs a list of jobs in parallel |
25
25
| Control | (optionOn) | Selects a list of jobs to run based on an option |
26
- | Control | (state) | Changes the current running state |
26
+ | Control | (stateOn) | Changes the current running state |
27
27
| Control | (pass) | Represents a pass-through job |
28
28
| Control | (fail) | Represents a failure job |
29
29
| Control | (check) | Organize idempotent jobs |
30
30
| Control | (wait) | Waits for a specific amount of time |
31
+ | Control | (state) | Changes the current state. |
31
32
| Data | (ch) | Operates data on an OpenAF channel |
32
33
| Input | (get) | Retrieves a global value from a key |
33
34
| Input | (fileget) | Retrieves arguments from a file |
44
45
| Output | (templateFolder) | Generates several outputs, based on templates, in a folder |
45
46
| Debug | (jobdebug) | Sets debug for a single job |
46
47
| Debug | (jobsdebug) | Sets debug for a series of jobs |
48
+ | Debug | (debug) | Outputs the current args and res values to help debug an ojob flow. |
47
49
| Security | (secget) | Obtains secret arguments (e.g. credentials) |
48
50
| Functionality | (fn) | Access an OpenAF functionality / function |
49
- | Functionality | (runfile) | Runs another local or remote oJob |
51
+ | Functionality | (run) | Runs another local or remote oJob |
50
52
|---|---|---|
51
53
52
54
---
@@ -213,7 +215,7 @@ todo:
213
215
214
216
```
215
217
216
- ### 🔖 (state )
218
+ ### 🔖 (stateOn )
217
219
218
220
Changes the current state depending on the value of a provided args variable.
219
221
@@ -260,11 +262,11 @@ todo:
260
262
261
263
Expects:
262
264
263
- * **(code )** : The exit code number to use.
265
+ * **(fail )** : The exit code number to use.
264
266
* **((force))**: A boolean indicating if instead of exit the processing should halt
265
267
266
268
```yaml
267
- - (code ): -1
269
+ - (fail ): -1
268
270
((force)): true
269
271
270
272
```
@@ -301,6 +303,19 @@ todo:
301
303
302
304
```
303
305
306
+ ### 🔖 (state)
307
+
308
+ Changes the current state.
309
+
310
+ Expects:
311
+
312
+ * **(state)**: The state to change to (to execute todo.when)
313
+
314
+ ```yaml
315
+ - (state): stateA
316
+
317
+ ```
318
+
304
319
---
305
320
306
321
## 🗂️ Data
@@ -395,10 +410,11 @@ todo:
395
410
396
411
Expects:
397
412
398
- * **((inKey))**: The path on the input contents for the string to convert
413
+ * **(convert)** : Where to find the input contents to convert (if 'args' will default to the current args)
414
+ * **((inPath))** : The path on the input contents for the string to convert
399
415
* **((inFormat))**: The format of the input contents (yaml, json, xml, ndjson, slon)
400
- * **((outKey))**: Where the converted output object should be placed (if 'args' with default to the current args)
401
- * **((outPath))**: The path on the output contents to store the converted object
416
+ * **((outKey))** : Where the converted output object should be placed (if 'args' with default to the current args)
417
+ * **((outPath))** : The path on the output contents to store the converted object
402
418
403
419
```
404
420
- name: Convert from JSON
@@ -568,7 +584,7 @@ todo:
568
584
569
585
todo:
570
586
- Replace text
571
-
587
+
572
588
```
573
589
574
590
### 🔖 (output)
@@ -578,7 +594,7 @@ todo:
578
594
Expects:
579
595
580
596
* **(output)** : The key string to retrieve previous results (defaults to 'res'). If "args" will retrieve from current args.
581
- * **((path))** : A path string to a map/array over the results set on key.
597
+ * **((path))** : A path string to a map/array over the results set on key.
582
598
* **((format))** : The output format (e.g. see ow.oJob.output help).
583
599
* **((title))** : Encapsulates the output map/array with a title key.
584
600
* **((internal))**: Boolean value that if true it will display the internal oJob entries on the arguments (default false).
@@ -757,10 +773,6 @@ todo:
757
773
758
774
```
759
775
760
- ---
761
-
762
- ## 🗂️ Security
763
-
764
776
### 🔖 (debug)
765
777
766
778
Prints the current "args" and "res"
@@ -774,6 +786,10 @@ todo:
774
786
775
787
```
776
788
789
+ ---
790
+
791
+ ## 🗂️ Security
792
+
777
793
### 🔖 (secget)
778
794
779
795
This job will get a SBucket secret and map it to oJob's args
0 commit comments