Skip to Content

GitHub Connector

Summary

The Jitterbit Harmony GitHub Connector establishes access to GitHub.

The GitHub connector provides an interface for creating a GitHub connection, the foundation used for generating instances of GitHub activities. These activities, once configured, interact with GitHub through the connection.

The GitHub connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a GitHub connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific GitHub connection and its activities are referred to as a GitHub endpoint:

GitHub activity types

These activity types are currently supported:

  • Search: Retrieves object data in GitHub and is intended to be used as a source in an operation.

  • Create: Creates object data in GitHub and is intended to be used as a target in an operation.

  • Delete: Deletes object data from GitHub and is intended to be used as a target in an operation.

  • Issues: Creates, deletes, queries, or updates issue data in GitHub and is intended to be used as a target in an operation.

  • Pull Request: Creates, deletes, queries, or updates pull request data in GitHub and is intended to be used as a target in an operation.

  • Update: Updates object data in GitHub and is intended to be used as a target in an operation.

These activity types are deprecated:

  • Query File: Queries a file in GitHub and is intended to be used as a source in an operation.

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

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

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

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The GitHub connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The GitHub connector uses the GitHub REST API. Refer to the API documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the GitHub connector, these troubleshooting steps are recommended:

  1. Ensure the GitHub connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.github" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.