Skip to content
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

Support project.yaml #1

Open
josephjclark opened this issue Jan 6, 2025 · 2 comments
Open

Support project.yaml #1

josephjclark opened this issue Jan 6, 2025 · 2 comments

Comments

@josephjclark
Copy link
Collaborator

josephjclark commented Jan 6, 2025

At the moment the plugin is focused around workflow.json, and tracks the project from that.

But it's probably more typical for a project to have a project.yaml file which is the primary source of truth. A project.yaml may have several workflows inside it.

It's probably still valuable to track a workflow.json. So maybe what we want to do is:

  • look for a project file. Look for project.yaml first, workflow.json second
  • maybe later we can be driven by .openfnrc if there is ambiguity

I don't think we need to support multiple project files in a single folder. Let's cut cloth on that for now - you can assume just one project root, which will be a yaml or json file.

I suspect the Workflows view should be renamed to Project view, and maybe later can include some metadata from project.yaml

@josephjclark
Copy link
Collaborator Author

Note to me:

The objective here is to make the extension seamless with CLI deploy and Github Sync (which both use project.yaml and state.json)

@josephjclark
Copy link
Collaborator Author

Reasons for hesitation on this:

  1. I think we need a common module in kit which builds a model of an openfn project. This can be re-used by the VSC extension and the CLI. Basically if we have one module which is really good at understanding the filesystem, we can re-use that module in a few places
  2. I'm thinking of a radical restructure of project.yaml. But I suppose even I do this, I'll need to support the "legacy" format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant