Basic store to GitHub store migration guide

This guide describes how to migrate Workflow definitions from a Basic store to a GitHub store.

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 each Workflow to a new file. On the Workflow Design screen, click Settings, then Update Workflow Definitions.

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 change a migrated Workflow, manually publish it to the lowest-ranked (Test) Environment.

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 screen.
  • Click the Promote button
  • Click Publish under the lowest ranking (Test) Environment

4. Promote Workflow (Optional)

Promotion is not required because Workflows published before the migration remain published and the workload is not affected. However, Manage releases will not show the published Workflow versions correctly until changes are promoted through all Environments.