Skip to main content

Setting Up the GitHub Pre-Built Recipes

Overview

The GitHub integration connects your CloudShare project to a GitHub repository, enabling automatic synchronization of customization content between the two systems.

Instead of manually tracking customization changes or rebuilding lost work, project members can rely on the integration to keep a version-controlled history of every change in GitHub, with the ability to roll back to a previous version at any time.

The integration is powered by three CloudShare-certified, pre-built Workato Recipes that work together to keep your CloudShare content and GitHub repository in sync:

  • Initial Sync (CloudShare to GitHub) - a run-once recipe that exports all existing customization content from your CloudShare project into GitHub. Run this first.
  • CloudShare to GitHub - an always-on recipe that pushes content changes to GitHub automatically each time a customization is saved in CloudShare.
  • GitHub to CloudShare - an always-on recipe that pulls content from GitHub and applies it to the relevant customization in CloudShare.

Each commit created by the sync automatically captures the CloudShare login email and exact timestamp of the change, giving you a built-in audit trail alongside your version history.

What Gets Synced? 

The GitHub integration syncs content-related customization parameters only.
Each customization is stored as a JSON file in the repository. 

Monitoring and Troubleshooting

Recipe run history, step-by-step logs, and error traces are available inside Workato, not inside CloudShare.

If a recipe fails, inspect the job log in the Workato interface by navigating to the relevant recipe and opening the Jobs tab to review execution details.

Before You Begin

Before activating the GitHub recipes, collect the following credentials from both GitHub and CloudShare. You will need them during the recipe setup.

In GitHub

  1. Create a new repository that will store your CloudShare customization data. Copy and save the exact repository name.
  2. Navigate to Developer Settings and create a new OAuth App with the following values:
  3. Copy and save the Client Secret together with the Client ID. Both will be required when setting up the GitHub Connector in Workato.

In CloudShare

  1. Navigate to your User Details page and copy your API ID and API Key.
  2. Navigate to Projects, open the relevant project's details screen, and copy the Project ID.
  3. Navigate to Account, open the Account Details screen, and copy the Account ID.
    It appears as the last segment of the URL.

Opening the GitHub Integration

To open the GitHub integration:

  1. Click the Integration Hub option in the left pane.
  2. Locate the GitHub card under Content Creation & Repositories and click More Details.
  3. In the information drawer that opens, click Continue.

This closes the information drawer and loads the Workato interface within CloudShare, opening the CloudShare Community Library filtered to show the three GitHub recipes.

Setting Up the Connectors

Before running any recipe, you need to connect both CloudShare and GitHub as data sources. This connector setup is done once and applies to all three recipes.

  • CloudShare connector - stores your API ID, API Key, Subscription, and Project details.
  • GitHub connector - stores your OAuth credentials (Client ID and Client Secret) and your repository details.

Activating the Recipes

CloudShare recommends activating the recipes in the following order:

  1. Initial Sync (CloudShare to GitHub)
  2. CloudShare to GitHub
  3. GitHub to CloudShare

To activate each recipe:

  1. Click the recipe to review its flow.
  2. Click Use this recipe and either select an existing Workato Workspace or create a new one to store a customized copy of the recipe.

  1. Once the recipe is duplicated, click Customize Recipe to enter edit mode.

  1. Follow the on-screen warnings and error notifications and fill in all missing information. This is where your connector credentials are entered.

  1. Click Save, then click Test. The recipe runs and displays a success message when the job completes.
  2. Click Exit to return to the recipe view, then click Start recipe.


Note: The recipes should remain in Active state after setup. Do not stop a recipe unless you intend to disable the sync.


 

Was this article helpful?