Versions Compared

Key

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

On this page

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

Additional menu and options are added in the SnapLogic Manager upon successful integration with GitHub.

...

A summary of these is as below:

...

Repository path and commit details.

...

Additional options in the Project options menu.

...

After you link a project with GitHub or GHES, SnapLogic Manager includes the following GitHub-specific information and controls:

...

These include the following:

These are covered in detail in the sections that follow.

Repository Path and Other Details

The following is an example of a project window after checking out a GitHub repository:

...

Below is a closer look at the repository path:

...

This is essentially composed of three parts:

...

  • The path of the GitHub repository. Clicking on the repository's path opens the repository in GitHub.

  • The commit ID. Clicking on the commit ID takes you to the commit's Asset table

Anchor
actions
actions
GitHub Actions

The following table describes the available GitHub actions and where you can find them:

Menu Item

Location

Description

Checkout GitHub Repository

Project options and GitHub Menu

Checkout GitHub repositories. Click to open Checkout GitHub Repository dialog box. You can also use GitHub API for this operation.

Commit to GitHub

Project options and GitHub Menu

Commit changes such as file updates to the GitHub repository. Click to open the Commit Changes dialog box.

GitHub Pull

Project options and GitHub Menu

Fetch the latest Assets commited to the GitHub repository. Click to open the Pull Messages dialog box. You can also use GitHub API for this operation.

Add to Repository

File options and GitHub Menu

Add an Asset to the GitHub repository. Click this to add to the repository. The GitHub status changes to Added. You must commit the change to update the GitHub repository.

Remove from Repository

File options and GitHub Menu

Remove an Asset from the GitHub repository. Click this to remove the Asset. The GitHub status change to Removed. You must commit the change to update the GitHub repository.

Anchor
repo_path
repo_path
Repository Path and Other Details

The repository path and commit details display above the Assets table:

...

From the path, you can perform the following:

  • Click the repository path to open the repository in GitHub.

  • Click the commit ID to open the commit details page in GitHub. This is update updated with each GitHub commit and pull. 

  • Username View the GitHub username of the GitHub account person that made the last commit.

Updated Project Options

The following items are added in the Project options menu:

...

Refer to the GitHub Options and their Functions section below for the functionality of each of the GitHub options in the menu.

...

titleOpening Project options menu

To open the Project options menu:

Hover mouse over the project, a downward arrow appears.

...

Click the arrow, Project options menu opens.

...

Updated File Options

File options menu is expanded to include GitHub-related items:

...

Anchor
project_options
project_options
Project Options Menu

The Project options menu includes three GitHub-specific actions:

...

Anchor
file_options
file_options
File Options Menu

The File options menu includes GitHub-specific actions:

...

One of the following options is shown in the File options menu based on the GitHub status of the file:

  • Add to Repository: After a file is added in to the project Project but not yet committed to the repository.

  • Remove from Repository: After a file is added in to the project and is committed to the repository.

Refer to the GitHub Options and their Functions section below for the functionality of each of the GitHub options in the menu.

...

titleOpening File options menu

To open the File options menu:

Hover mouse over the File, a downward arrow appears.

...

Click the arrow, File options menu opens.

...

Anchor
github_menu
github_menu
GitHub Menu

The GitHub icon is added to the Asset table 's toolbar. Clicking this icon opens toolbar contains a GitHub button, (blue star). Click it to open the GitHub menu:

...

The following options are available in the GitHub menu:

  • Checkout GitHub Repository

  • Commit to GitHub

  • GitHub Pull

  • Add to Repository

  • Remove from Repository

Refer to the GitHub Options and their Functions section below for the functionality of each of the GitHub options in the menu.

...

Anchor
github_status
github_status
GitHub Status Column

The GitHub Status column in the Project Asset table displays the status of the project asset in the repository. Each asset has An Asset can have one of the following statuses:

  • Tracked: Assets are updated in The Asset has been committed and the repository tracks updates.

  • Untracked: Assets are not updated in the repositoryThe repository does not track Asset updates.

  • Added: Assets are added but not committed in the repository The repository has staged the Asset, but it is not committed.

  • Removed: Assets are removed The repository has staged the removal, but the file delete is not committed in the repository.

  • Unsupported: Asset type is not supported.  The Asset type cannot be tracked in the repository.

Note

Assets with GitHub status Untracked, Added and Removed do not show in the GitHub repository unless committed.

GitHub Options and their Functions

...

Menu Item

...

Location

...

Description

...

Checkout GitHub Repository

...

Project options and GitHub Menu

...

Checkout GitHub repositories. Clicking on this opens the Checkout GitHub Repository dialog box. You can also use GitHub API for this operation.

...

Commit to GitHub

...

Project options and GitHub Menu

...

Commit changes such as file updates in the GitHub repository. Clicking on this opens the Commit Changes dialog box.

...

GitHub Pull

...

Project options and GitHub Menu

...

Fetch updates from the GitHub repository. Clicking on this opens the Pull Messages dialog box. You can also use GitHub API for this operation.

...

Add to Repository

...

File options and GitHub Menu

...

Add asset to the GitHub repository. Clicking on this changes the GitHub status to Added. You will need to commit changes to update the GitHub repository.

...

Remove from Repository

...

File options and GitHub Menu

...

Remove asset from the GitHub repository. Clicking on this changes the GitHub status to Removed. You will need to commit changes to update the GitHub repository.

...

See Also

...

GitHub Documentation

...

Related Content