Skip to end of metadata
Go to start of metadata

GitHub Connector

Summary

The GitHub connector for Jitterbit Harmony Cloud Studio provides an interface for entering user-provided input such as credentials to create an authenticated GitHub connection. That connection provides the foundation to configure associated GitHub connector activities that interact with the connection. Together, a specific GitHub connection and its activities are referred to as a GitHub endpoint.

Supported API Versions and Prerequisites

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

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.

Connector Overview

This connector is used to first configure a GitHub connection, establishing access to GitHub, and then used to configure one or more GitHub activities associated with that connection as a source or target within an operation:

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

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

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

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

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

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

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

  • Issues: Queries, creates, updates, or deletes a GitHub issue at a GitHub endpoint and is intended to be used as a target in an operation.

  • Pull Request: Queries, creates, updates, or deletes a pull request at a GitHub endpoint and is intended to be used as a target in an operation.

NOTE: Verbose logging can be enabled for this connector when it is used with a Private Agent. See Verbose Logging for Connectors and Private Agents for details.

Accessing the Connector

The GitHub connector is accessed from the Connectivity tab of the design component palette by using the Show dropdown to filter on Connectors.

Once a connection is configured, activities associated with the endpoint are available by using the Show dropdown to filter on Endpoints and then clicking the GitHub connection block:

Activities

Search in This Topic

 

  • No labels