Versions Compared

Key

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

...

We recommend using different SnapLogic Orgs during development, testing, and deployment. With the Git Integration, you and your colleagues can work on the same Project in different Orgs and track it in the same GitHub repository. For example, in a development Org, you might associate Project-1 with a dev branch. When the Assets are ready for testing, commit and merge them to the test branch. When testing and bug fixing is complete, merge the changes into the main branch and in GitHub create a release for the production Org.

Prerequisites

Limitations

The Git Integration has the following limitations:

  • Snap Pack and Snaplex Assets cannot be tracked.

  • You cannot track more than 1,000 Assets per project.

Workflow

The workflow to begin tracking Project Assets in GitHub includes the following:

...

Table of Contents
minLevel1
maxLevel2
excludePrerequisites|Limitations|Workflow|Related Content

Creating a Project from a GitHub Repository

To create a Project in SnapLogic Manager when you have a Git Integration subscription:

  1. In the navigation tree, click the Project Space where you want to create a Project.

  2. Click Create Project

  3. Enter a name in the Project name field. 

  4. Select the Create from Git Checkout checkbox to create a project.

  5. Select a repository for the Project in the Repositories field.

  6. Select the branch where you want to create a Project in the Branches/Tags field.

  7. Click Checkout to create a new Project.

Associating Project Assets with a Repository

Use Manager to check out a GitHub repository for tracking Project Assets. If a repository for a Project does not exist, you must first create it in GitHub.

Checking out a Branch or a Tag

Check out a repository branch or tag in Manager:

...

  • Tracked

  • Tracked, Modified Locally

  • Tracked, Modified Remotely

  • Tracked, Conflict

  • Untracked

  • Added

  • Removed

...

Creating a New Branch

Create a new branch from the branch that is already checked out for a Project. For example, to create a new branch from the main branch, first, check out main.

...

The Git Integration creates a new repository branch based on the existing branch.

Creating a New Tag

Git tags reference a specific commit and are commonly used to identify releases. To create a tag from Manager, a branch or a tag must already be checked out for the Project.

...

The new tag is associated with the current commit of the branch.

Switching Branches

To switch to a different branch, follow these steps in Manager:

...

The Git Integration updates Assets to the state last committed to that branch or tag.

Adding a Single Asset

Assets that are not part of the repository have a GitHub Status of Untracked. You can add Assets individually or commit changes to add multiple Assets at the same time. Individually added Assets are not visible in GitHub until you commit them.

...

  1. In the navigation tree, select the Project to display the Assets table.

  2. Find the Asset to add.

  3. Open the options menu by clicking the arrow to the right of the Asset name.

  4. Select Add to Repository:

    Add to repository

    The GitHub Status changes to Added.

Committing all Updated Assets

Update one or many Assets in a single commit. When you commit Project changes, you can select from a list of updated Assets to commit.

...

You can log in to your GitHub account to confirm the commit.

Removing Assets

You can delete any type of tracked Asset from the GitHub repository. This does not delete the Asset from the Project, but does stop GitHub from tracking it. Similar to the add operation, after removing an Asset, you must commit Project changes before the Asset is actually removed from GitHub.

...

  1. In the navigation tree, select the Project to display the Assets table.

  2. Find the Asset to remove.

  3. Open the options menu by clicking the arrow to the right of the Asset name.

  4. Click Remove from Repository.

    Remove from repository

    The GitHub Status changes to Removed.

Pulling from a Repository

If you or a colleague make any changes to Assets in the GitHub repository, pull the changes into the Project to synchronize the updates.

Pulling Updates with No Conflicts

When the state of Assets in the GitHub repository differs but does not conflict, pull updates as follows:

  1. In the navigation tree, click the arrow to the right of the Project name to open the options menu.

  2. Select GitHub Pull.

  3. The GitHub Pull Messages dialog lists the Assets that were fetched from GitHub.

  4. Click OK to update the Assets with the changes from GitHub.

Pulling Updates with Conflicts

If an Asset was changed in both GitHub and a different change was made in the IIP since the last commit, pulling from GitHub creates a conflict. The Pull Messages dialog allows you to resolve the conflict:

...

  • To overwrite the local file, select it and click Pull.

  • To retain the local file, do not select the checkbox and click Pull, then commit the Project.

Related Content