Where Can I Find Documentation to Create Pipedream Workflows Locally and Deploy to GitHub?

This topic was automatically generated from Slack. You can find the original thread here.

Hi all. Wondering where the documentation is to create Pipedream workflows locally → Github → deploy to Pipedream? I see mentions of “develop workflows locally” and Github syncing in docs, but no docs on how to create workflows via code?

I also see “Do you have a definition of this YAML?: Not yet, please stay tuned!”

  1. Does someone have a link to an example Pipedream YAML workflow? (Should I assume it might be similar to say an Ansible-like config YAML?)
  2. If this definition is not yet available, does that mean that I cannot develop locally yet? (Can’t develop what’s not defined?) And so Github sync is solely this, atm?: Develop in Pipedream GUI → syncs to Github → Don’t edit locally unless you’d like to edit the various knowable js/phython/go etc action steps, but maybe not Pipedream-specific configs that don’t yet have documentation…?
    Trying to see the big picture of how to/if I should edit outside of the GUI. Thanks!

Thanks much.

Hi , the develop workflows via code feature is not supported currently, but we plan to do that in the future!

Gotcha. Thanks Andrew.

Andrew, I so see mention in your docs of “Projects that use GitHub sync may be edited outside of Pipedream. You can edit and commit directly via GitHub’s UI or clone the repo locally and use your preferred editor (e.g., VSCode).”

So is this true re: that statement (what i updated my original post with?):

Github sync is this, atm?: Develop in Pipedream GUI → syncs to Github → Don’t edit locally unless you’d like to edit the various knowable js/phython/go etc action steps, but maybe not Pipedream-specific configs that don’t yet have documentation…?

Responding your specific questions:

  1. Do you have GH Sync enabled? If you deploy a workflow, you’ll be able to see the workflow.yaml file in your GitHub repo.
  2. The definition is not yet available publicly, as we are working on refining it. Edits to the workflow.yaml are allowed and will take effect when merged to production. But we don’t yet support deploying workflows from zero (e.g. with new spec files)

Thanks Andrew.