Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This page is no longer maintained (). For the most current information, go to https://docs.snaplogic.com/cicd/git-integration/git-integration-about.html.

On this page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Panel
bgColor#ebf7e1
borderStylesolid

Articles in this section

Child pages (Children Display)
alltrue
depth2

Prerequisites

  • The SnapLogic App must be installed in GitHub. See Installing the SnapLogic App for details.
  • Your GitHub account should have read and write access to your organization's GitHub repositories.

See Also

  • GitHub Documentation
  • GitHub Operations APIs
  • Thread on GitHub Integration in the SnapLogic Community

    Overview

    Integrate your SnapLogic account with GitHub repositories. The following project assets are supported:

    • Files
    • Pipelines
    • Tasks
    • Accounts. 
    APIs are also available to perform pull requests or checkout repositories. Seethe GitHub Operations APIsfor details.
    Note
    titleGitHub Version

    We support and test against GitHub version 3.

    Key Features

  • Checkout GitHub repositories to a project.
  • Checkout GitHub repositories or perform Pull requests using GitHub APIs. See GitHub Operations APIsfor details.
  • Add/Update/Delete files in repositories through SnapLogic.
  • Add/Update/Delete project assets through GitHub.
  • Workflow

    Image Removed

    Note

    Snap Packs and Snaplexes cannot be migrated to GitHub. If there are Snap Packs or Snaplexes in your project, they are listed as Unsupported (GitHub Status) in the Asset table. 

    The SnapLogic Git Integration currently supports GitHub.com or, with a subscription, GitHub Enterprise Server (GHES). The Git Integration allows you to track, update, and version SnapLogic Project files, Pipelines, Tasks, and Accounts from the SnapLogic user interface. SnapLogic APIs also support Git operations.

    After a Git Integration is enabled for a SnapLogic Org and a user has authorized and authenticated their account, they can add Project Assets to a repository. Users having access to the Project can collaborate. If you use different Orgs for development, testing, and production, a repository can track the same Project Assets across all of the Orgs, supporting Continuous Integration and Continuous Development (CI/CD). The Git Integration supports Gitflow workflow and Trunk-based development, but we recommend trunk-based development.

    Limitations

    The Git Integration has the following limitations:

    • Snap Pack and Snaplex Assets cannot be tracked.

    • You can only track 1,000 Assets per Project.

    Prerequisites

    To enable one of the Git Integrations:

    • A repository for each Project must exist or be created in the appropriate GitHub organization or in GHES.

    • GitHub requirements include the following:

      • For organizational repositories, a GitHub organization administrator must install a SnapLogic App in GitHub.

      • For personal repositories, the owner must install a SnapLogic App in GitHub.

    • GHES requirements include the following:

      • A GHES administrator must create a SnapLogic App in GHES

      • An IT administrator must set up secure network connections.

    • For both GitHub and GHES, user accounts must have read and write access to the appropriate GitHub repositories and SnapLogic Projects. Individual users must authorize SnapLogic to interact with their GitHub account.

    The following pages describe how to configure the Git Integration for:

    Related Content