Using Git with workflows

Overview

At any time, you have the option to store your workflows in a remote Git repository.

Before you begin

You need to have an account on GitHub as well as an established repository.

Decide which flows you want to push into your repository or the ones you need to pull from it, if any.

Configuring Git

  1. When you click the three-dot button at the top-right corner of the page and select Git Config, a separate window with fields will open.
  2. Choose the Auth Key associated with the repository. If you don’t have one in the dropdown, you’ll need to manually create it by clicking the + button.
  3. In the Create Authentication window, fill out the following information:
    Name
    The name of your authentication key.
    Description
    An optional description for your authentication key.
    Service
    The integration name (Git).

    Depending on the service you’ve selected, you may need to provide additional values. They’ll require sensitive information (credentials) needed for the connection of the service with the platform.

    URL
    The unique link of your Git repository. This should be the full path ending in <your-project>.git (eg https://github.com/shane/flek3s.git). GitHub and others will show this value under the Clone function.
    Branch
    The branch can be populated here to hard set or will be select-able in the Git configuration once you fill out the other fields. Check the Overridable checkbox for this if you do not set it here. Your branch must already exist in Git.
    Username
    The username associated with your Git provider.
    Password
    The password associated with your Git username. If you are using GitHub Cloud or Enterprise, the password must be a personal access token for the user, as GitHub has phased out support for passwords.
    Email
    The email address associated with your Git username.
    RSA Private Key
    Private key used for SSH key authentication (if using SSH in lieu of password/token).

    Check the Overridable checkboxes to make fields editable later. Otherwise, future changes would not be possible.

  4. Click Save to add the Auth Key.
    If you hadn’t checked any Overridable checkboxes, the optional URL and Branch fields cannot be modified. Otherwise, you will be able to select and/or change your URL and branch.
    In addition, when you have a couple of branches available, you can search for them in the bar that appears below the Branch field.
  5. Click Save to finish setting up Git.

Using Git with workflows

Once you’ve configured Git, the three-dot button will exhibit new properties.

Edit Git config
Takes you back to the Config menu where you can apply changes to the fields you’ve specified as overridable.
Git Pull & Reset
Takes the contents from your repository and overwrites any existing flows and/or folders within your the platform workspace.
Git Push
Takes the contents from your the platform workspace/folder and overrides any existing flows and/or folders within your repository. You have the option to include a message associated with the action.
Delete Config
Removes the configured Git. A warning will appear before the action is executed.
To pull or push multiple workflows from/to Git, simply select them and click the respective button from the dropdown.
Single-workflow push is also possible through the three-dot button menu on the far-right of the flow.
The action will trigger the respective push popup, this time customised for the particular workflow.
Note: Only the latest version of a workflow can be pushed to Git.