Skip to end of metadata
Go to start of metadata

Introduction

A GitHub connection is configured via the GitHub connector to establish access to an account on the GitHub server. Once a connection is established, you can configure one or more GitHub activities associated with that connection to use as a source or target within an operation.

Creating or Editing a GitHub Connection

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

To configure a new GitHub connection, within the Connectors filter, click the GitHub connector block:

Connectivity tab

To configure an existing GitHub connection, within the Endpoints filter, double-click the GitHub connection block:

Connectivity tab

This will open a configuration screen for the GitHub connection, covered next.

Configuring a GitHub Connection

Configuration of a GitHub connection includes these fields:

Connectivity tab

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Endpoint Name: Enter a name to use to identify the GitHub connection. The name must be unique for each GitHub connection and must not contain forward slashes (/) or colons (:).

  • GitHub Username: Enter the GitHub username that you previously saved. See GitHub Registration.

  • GitHub Personal Access Token: Enter the GitHub personal access token that you previously saved. See GitHub Registration.

  • Test: Click this button to verify the connection. The server will check only that the specified user can make a connection.

  • Save Changes: Click this button to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click Discard Changes to close the configuration without saving. A message will ask you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click Delete to permanently delete the connection from the project and close the configuration see Component Dependencies, Deletion, and Removal.

Next Steps

After configuring a GitHub connection, you can configure one or more GitHub activities associated with that connection to use as a source or target within an operation. For more information, see these pages:

  • Query File: Retrieves a file from a GitHub repository and is used as a source in an operation.

  • Create File: Creates a file in a GitHub repository and is used as a target in an operation.

  • Update File: Updates a file in a GitHub repository and is used as a target in an operation.

  • Delete File: Deletes a file from a GitHub repository and is used as a target in an operation.

On This Page

Last updated:  Jun 25, 2019

  • No labels