-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CLI: generate workflow.json #615
Comments
Closed
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as off-topic.
Hi all, apologies for the confusion here. This particular issue is not being sponsored as part of DMP 2024. You can find a list of all DMP 2024 issues here: https://github.com/orgs/OpenFn/projects/3/views/3?filterQuery=is%3Aissue+label%3A%22DMP+2024%22 |
This comment was marked as off-topic.
This comment was marked as off-topic.
This comment was marked as resolved.
This comment was marked as resolved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Overview
Developers and technical users often define their own workflows to test things out locally by writing their workflows in the JSON format that is quite fiddly and requires the developer to remember the right key names and structure (which is not always intuitive).
See the
Workflows
section of the readme.Background
The OpenFn platform is an open source tool for data and workflow automation which provides users with the two different types of interface: The CLI and Lightning (a web based platform that provides a GUI/Canvas for users to design their workflows, write job expressions and run work orders.)
Requirements
We should add an interactive command to the existing CLI which makes it easy to generate a workflow. The command should ask the following questions:
Note the following:
-
, special characters removed etc)expression: "./fetch-data.js"
, and each expression file should contain a basic expression of the formfn((state) => state)
next)
generated for it, with condition!state.error
Pretty much the minimum we expect is to generate two jobs with an edge between them. Ideally you could run this in the CLI directly without any errors (this will work if the adaptor is
common
).Testing
It is too hard to unit test the final automated command, but we do expect unit tests on the individual functions used by the command.
Useful Resources
The text was updated successfully, but these errors were encountered: