Welcome to the beta release for Pipedream ↔ GitHub sync! Thank you in advance for your participation and feedback.

Overview

When enabled, this feature will serialize your Pipedream workflows and synchronize changes to a GitHub repo. Capabilities include:

• Bi-directional GitHub sync (push and pull changes)
• Edit in development branches
• Track commit and merge history
• Link users to commits
• The Merge from Pipedream or create PRs and merge from GitHub
• Edit in Pipedream or use a local editor and synchronize via GitHub (e.g., edit code, find and replace across multiple steps or workflows)
• Organize workflows into projects with support for nested folders

Getting Started

<aside> ⚠️ GitHub Sync is currently in beta. We recommend restricting use to non-critical workflows at this time.

</aside>

Create a new project and enable GitHub Sync

Projects are a new concept we are introducing to Pipedream. A project may contain one or more workflows and may be further organized using nested folders. Each project may be synchronized to a single GitHub repo.

• Go to https://pipedream.com/projects
• Create a new project
• Enter a project name and check the box to Configure GitHub Sync

  • To use OAuth

    • Select a connected account, GitHub scope and repo name

    • Pipedream will automatically create a new, empty repo in GitHub

      

  • To use Deploy Keys

    • Create a new repo in GitHub

    • Follow the instructions to configure the deploy key

    • Test your setup and create a new project

      

Create a branch to edit a project

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> All changes to resources in a project must be made in a development branch. Examples of changes include creating, editing, deleting, enabling, disabling and renaming workflows.

</aside>