Basic store to GitHub store migration guide

Steps

1. Get Workflow Definitions

Option 1: Copy Workflow definitions manually

If you have a small number of Workflows, you can copy the JSON definition of the Workflow to a new file. Access the JSON of the Workflow definition from the Workflow Design Pane by clicking Workflow Settings, then Definition.

Store each Workflow in a file named according to this format: site-{siteKey}/workflow-{workflowKey}.json

Option 2: Request Flowgear Support

Contact Flowgear Support to have all Workflow definitions for the lowest-ranking (Test) Environment transferred to a GitHub repository. A GitHub repository must be created and access provided to the Flowgear engineer handling the request. (You may cycle access tokens once Flowgear has completed the migration for you).

2. Configure Flowgear Site Settings

Add the GitHub repository URL in Flowgear Site Settings and update Environment branch names. Common practice:

  • test for the Test Environment
  • master for the Production Environment

Generate a Personal Access Token in GitHub and save it in the User profile page in Flowgear.

3. Publish Workflows in Flowgear

The first time you make a change to a Workflow that has been migrated, you'll need to manually publish it into the lowest ranking (Test) Environnent.

If you have not done this, you will receive the error This workflow has been modified since it was acquired. The update is cancelled to prevent overwrite of those changes. when clicking Save.

To publish the Workflow:

  • Open the Workflow Design Pane
  • Click the Promote button
  • Click Publish under the lowest ranking (Test) Environment

4. Promote Workflow (Optional)

Promotion is not required because all Workflows published prior to migrating to GitHub are still published and workload will not be affected. However, the Promote Pane will not correctly show published Workflow versions until changes are promoted through all Environments.