How to use IBM App Connect with GitHub

Connecting to GitHub

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your GitHub administrator to obtain these values.

To connect to a GitHub endpoint from the App Connect Designer Catalog page for the first time, expand GitHub, then click Connect. For more information, see Managing accounts.

General considerations

Before you use App Connect Designer with GitHub, take note of the following considerations:

• You require scopes such as repo and delete_repo for connecting to the GitHub connector. For more information about these scopes, see Scopes for OAuth Apps on the GitHub Docs page.
• Except for the Organizations object, you need to select an organization from the drop-down list to perform any kind of operation.
  In the following example of using a Create issue action from the Issues object, the first option in the list corresponds to the login ID of the authenticated user, and the rest of the list corresponds to the organization IDs to which the user belongs:

  

  Here, if you select the login ID from the list, you can select your personal repositories to perform any create, retrieve, update, and delete operations or custom event operations.

• For some objects (Reviews, Commit comments, Review comments, and Comments), if you use the ID filter for retrieving a single object, the mandatory drop-down list value that is selected will be ignored.
  In the following example, if you enter a value in the Review ID filter, then the Pull request value that is selected by you from the drop-down list will be ignored.

  

  Also, in this example, if you select any other filter values other than the Review ID or do not apply any filters, then all the reviews from the selected Pull request value are shown.

• (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

  For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

GitHub events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.

GitHub actions

Your flow completes these actions on this application.

Branches

Retrieve branches

Merge branch

Issues

Create issue

Retrieve issues

Update issue

Add assignees

Remove assignees

Organizations

Retrieve organizations

Update organization

Pull requests

Create pull request

Retrieve pull requests

Update pull request

Merge pull request

Repositories

Create repository

Retrieve repositories

Update repository

Delete repository

More items are available when you have connected App Connect to GitHub.