Skip to content

Commit 1b4054a

Browse files
committed
Update shortcuts.yaml with new control and debug options
1 parent 70ed7bd commit 1b4054a

File tree

1 file changed

+30
-14
lines changed

1 file changed

+30
-14
lines changed

cheatsheet/ojob/shortcuts.yaml

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ todo:
2323
| Control | (todo) | Sub ToDo list |
2424
| Control | (parallel) | Runs a list of jobs in parallel |
2525
| 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 |
2727
| Control | (pass) | Represents a pass-through job |
2828
| Control | (fail) | Represents a failure job |
2929
| Control | (check) | Organize idempotent jobs |
3030
| Control | (wait) | Waits for a specific amount of time |
31+
| Control | (state) | Changes the current state. |
3132
| Data | (ch) | Operates data on an OpenAF channel |
3233
| Input | (get) | Retrieves a global value from a key |
3334
| Input | (fileget) | Retrieves arguments from a file |
@@ -44,9 +45,10 @@ todo:
4445
| Output | (templateFolder) | Generates several outputs, based on templates, in a folder |
4546
| Debug | (jobdebug) | Sets debug for a single job |
4647
| 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. |
4749
| Security | (secget) | Obtains secret arguments (e.g. credentials) |
4850
| 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 |
5052
|---|---|---|
5153
5254
---
@@ -213,7 +215,7 @@ todo:
213215
214216
```
215217
216-
### 🔖 (state)
218+
### 🔖 (stateOn)
217219
218220
Changes the current state depending on the value of a provided args variable.
219221
@@ -260,11 +262,11 @@ todo:
260262
261263
Expects:
262264
263-
* **(code)** : The exit code number to use.
265+
* **(fail)** : The exit code number to use.
264266
* **((force))**: A boolean indicating if instead of exit the processing should halt
265267
266268
```yaml
267-
- (code ): -1
269+
- (fail ): -1
268270
((force)): true
269271
270272
```
@@ -301,6 +303,19 @@ todo:
301303
302304
```
303305
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+
304319
---
305320
306321
## 🗂️ Data
@@ -395,10 +410,11 @@ todo:
395410
396411
Expects:
397412
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
399415
* **((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
402418
403419
```
404420
- name: Convert from JSON
@@ -568,7 +584,7 @@ todo:
568584
569585
todo:
570586
- Replace text
571-
587+
572588
```
573589
574590
### 🔖 (output)
@@ -578,7 +594,7 @@ todo:
578594
Expects:
579595
580596
* **(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.
582598
* **((format))** : The output format (e.g. see ow.oJob.output help).
583599
* **((title))** : Encapsulates the output map/array with a title key.
584600
* **((internal))**: Boolean value that if true it will display the internal oJob entries on the arguments (default false).
@@ -757,10 +773,6 @@ todo:
757773
758774
```
759775
760-
---
761-
762-
## 🗂️ Security
763-
764776
### 🔖 (debug)
765777
766778
Prints the current "args" and "res"
@@ -774,6 +786,10 @@ todo:
774786
775787
```
776788
789+
---
790+
791+
## 🗂️ Security
792+
777793
### 🔖 (secget)
778794
779795
This job will get a SBucket secret and map it to oJob's args

0 commit comments

Comments
 (0)