GitHub

GitHub is an online software development platform. You can use GitHub to store, track, and collaborate on software projects. This document describes how to connect IBM watsonx Orchestrate to GitHub and use its skills on watsonx Orchestrate.

Before you begin

To connect watsonx Orchestrate to GitHub, make sure that you have a GitHub account. If you don't have a GitHub account, you can create one at try GitHub for free.

Connecting to GitHub

Important:
- A credential type must be set for apps that are a part of team skill sets and AI assistants. Skill-based actions in AI assistants support only shared credentials.
- If a credential type of an app is not specified, an error message is displayed when users attempt to run the skills of the app. To resolve the error, an admin must set the credential type for the app. For more information, see Managing connections.

An app can be connected either through the skill catalog or through the watsonx Orchestrate chat. Use the method that suits you to connect to an app.

Connect to the app through the skill catalog when you add that skill to your skill set:

  1. On the watsonx Orchestrate chat page, click Add skills from the catalog.
  2. Search and click the app tile.
  3. Click Connect app.
  4. Configure the connection. For more information, see Configuring the connection.
  5. Click Connect app.

Otherwise, connect to that app through the watsonx Orchestrate chat when you use the skill:

  1. Open the watsonx Orchestrate chat.
  2. On the chat, start the skill.
  3. Click Connect app.
  4. Configure the connection. For more information, see Configuring the connection.
  5. Click Connect app.

Configuring the connection

To connect watsonx Orchestrate to GitHub, complete the following steps:

  1. Click Connect app.
  2. In the Endpoint URL, enter the endpoint URL of your GitHub instance, for example, "https://<hostname>".
  3. In the Personal access token, enter the personal access token. To generate a personal access token, see Creating personal access tokens.
  4. Click Connect app.
Note: The icon A green check icon appears to show that the app is connected. indicates that the connection was successfully established.

Creating a personal access token

To create a personal access token, complete the following steps:

  1. Go to your GitHub Cloud or GitHub Enterprise Server account.
  2. Click your profile photo in the upper-right corner of your GitHub page, then click Settings.
  3. Click Developer settings > Personal access tokens.
  4. Click Generate new token.
  5. In the Note field, specify the name of your token.
  6. Select Expiration, choose a default option or click Custom to enter a date.
  7. Select the scope that you like to grant this token. To use your token to access repositories from the command line, select repo. A token with no assigned scope can only access public information.
  8. Click Generate token.

Technical parameters

The following table contains the technical parameters required by some skills of this app and instructions to retrieve them.

Parameters Details
Organization or Owner name To get the organization or owner name, use the Get all organizations skill.
Repository name To get the repository name, use the Get all repositories skill.

What to do next

After you connect to the app, you can use the GitHub skills. For more information see, Using the chat.

To learn about the available skills, see List of prebuilt apps, skills and skill flows.


Parent topic:

Connecting to apps