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

Add "--describe" to CLI #278

Closed
taylordowns2000 opened this issue Jun 26, 2023 · 0 comments · Fixed by #290 or #297
Closed

Add "--describe" to CLI #278

taylordowns2000 opened this issue Jun 26, 2023 · 0 comments · Fixed by #290 or #297
Assignees

Comments

@taylordowns2000
Copy link
Member

taylordowns2000 commented Jun 26, 2023

Add a --describe function to the openfn deploy CLI, which given a configuration, returns a project.yaml and state.yaml for the requested project.

We'll be using this for the "automated commits to github" story so that changes made through the UI in Lightning can be committed to github.

More context

  1. you’ve just built an API in lightning that returns a project.yaml. Make it possible to call this API using an API-TOKEN
    • (That may require a PR against Lightning before a PR against Kit.)
  2. there’s an existing API in lightning that already returns a .state.json, and it’s already accessible via API-TOKEN
  3. once you’re happy with how allow cron #1 and Setup example fails, could not resolve "@openfn/workflow-diagram" #2 work, extend the CLI with a function that, when given a configuration.json and (somehow…) a projectUuid (via cli argument maybe? via config?) overwrites whatever is in the projectPath and statePath with the results of allow cron #1 and Setup example fails, could not resolve "@openfn/workflow-diagram" #2 from Ligthning.

Another way to think of it

  1. this is being used by a local developer to DISCOVER changes to a remote project.
  2. Imagine you’re in a git repo.
  3. You run openfn deploy --describe .c config.json
  4. You run git diff
  5. You see how the project has been changed remotely and decide whether or not to commit or discard those changes to your repo.
@amberrignell amberrignell changed the title Add "export as YAML" to CLI Add "--describe" to CLI Jul 5, 2023
@zacck zacck self-assigned this Jul 10, 2023
@zacck zacck closed this as completed Jul 17, 2023
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

Successfully merging a pull request may close this issue.

2 participants