@openfn/cli 0.4.1 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -23
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -180,7 +180,7 @@ Example config file:
|
|
|
180
180
|
|
|
181
181
|
// Optional: defaults to OpenFn.org's API, can be overridden or set with
|
|
182
182
|
// `OPENFN_ENDPOINT` env var
|
|
183
|
-
"endpoint": "https://app.openfn.org
|
|
183
|
+
"endpoint": "https://app.openfn.org"
|
|
184
184
|
}
|
|
185
185
|
```
|
|
186
186
|
|
|
@@ -261,30 +261,28 @@ To see an example workflow, run the test command with `openfn test`.
|
|
|
261
261
|
|
|
262
262
|
A workflow has a structure like this (better documentation is coming soon):
|
|
263
263
|
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
{
|
|
267
|
-
"start": "a", // optionally specify the start node (defaults to jobs[0])
|
|
268
|
-
"jobs": [
|
|
264
|
+
```json
|
|
269
265
|
{
|
|
270
|
-
"
|
|
271
|
-
"
|
|
272
|
-
|
|
273
|
-
"
|
|
274
|
-
"
|
|
275
|
-
"
|
|
276
|
-
//
|
|
277
|
-
//
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
266
|
+
"start": "a", // optionally specify the start node (defaults to jobs[0])
|
|
267
|
+
"jobs": [
|
|
268
|
+
{
|
|
269
|
+
"id": "a",
|
|
270
|
+
"expression": "fn((state) => state)", // code or a path
|
|
271
|
+
"adaptor": "@openfn/language-common@1.75", // specifiy the adaptor to use (version optional)
|
|
272
|
+
"data": {}, // optionally pre-populate the data object (this will be overriden by keys in in previous state)
|
|
273
|
+
"configuration": {}, // Use this to pass credentials
|
|
274
|
+
"next": {
|
|
275
|
+
// This object defines which jobs to call next
|
|
276
|
+
// All edges returning true will run
|
|
277
|
+
// If there are no next edges, the workflow will end
|
|
278
|
+
"b": true,
|
|
279
|
+
"c": {
|
|
280
|
+
"condition": "!state.error" // Not that this is an expression, not a function
|
|
281
|
+
}
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
]
|
|
282
285
|
}
|
|
283
|
-
}
|
|
284
|
-
},
|
|
285
|
-
]
|
|
286
|
-
}
|
|
287
|
-
|
|
288
286
|
```
|
|
289
287
|
|
|
290
288
|
## Compilation
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openfn/cli",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "CLI devtools for the openfn toolchain.",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18",
|
|
@@ -44,11 +44,11 @@
|
|
|
44
44
|
"rimraf": "^3.0.2",
|
|
45
45
|
"treeify": "^1.1.0",
|
|
46
46
|
"yargs": "^17.7.2",
|
|
47
|
-
"@openfn/compiler": "0.0.
|
|
48
|
-
"@openfn/deploy": "0.2.
|
|
47
|
+
"@openfn/compiler": "0.0.37",
|
|
48
|
+
"@openfn/deploy": "0.2.8",
|
|
49
49
|
"@openfn/describe-package": "0.0.18",
|
|
50
|
-
"@openfn/logger": "0.0.
|
|
51
|
-
"@openfn/runtime": "0.0.
|
|
50
|
+
"@openfn/logger": "0.0.18",
|
|
51
|
+
"@openfn/runtime": "0.0.32"
|
|
52
52
|
},
|
|
53
53
|
"files": [
|
|
54
54
|
"dist",
|