Create a Github integration

note

This integration supports only one-way synchronization (from GitHub to TestOps).

This document shows you how to create an integration for Github within Katalon TestOps.

To set up the integration, the Account Admin or System Admin must first connect a GitHub account or organization and link the desired projects (repository, branch, or directory) to TestOps. Go to Roles or Permissions for more information or learn how to assign an Account Admin here.

Connect a Github account to TestOps

Prerequisites

You must possess the Account Admin or Project Admin role to perform this action.

---

To set up the connection:

1. Navigate to Admin > System > System Integrations > Create Integration.

2. In the Available Integration list, choose Github.

   

3. Fill in the required fields to establish the connection.

• In the Personal Access Token (PAT) field, enter your GitHub PAT. To generate a PAT, refer to this GitHub documentation on creating a personal access token.

  • Ensure you create a classic PAT and select the repo scope to set the appropriate permissions.

    

5. Click Test Connection to validate the integration.

Result

To verify if the connection is active, navigate to Admin > System > System Integrations. Your GitHub integration will be listed under the Integration list.

Link a Github repository to TestOps

Once an Account Admin sets up the GitHub connection, only Project Admin can configure project-level settings by linking specific repositories, branches, or directories to Katalon TestOps:

1. Navigate to Admin > System > System Integrations .

2. Hover over the right edge of your linked connection and click the Setting icon.

   • For example: If you have connected a Git connection called Katalon-Repo-Test.

3. Fill in the required fields. In the URL field, navigate to the desired repository, branch, or directory from the linked GitHub account. Copy and paste the URL into the field for your project.

4. Click Proceed.

   • If the status initially shows as Inactive, reload the page to update the status to Active.
   • If you modify the connection details and click Save, the status may remain Inactive until you reload the page.

5. [Optional] To edit an existing project, click the Edit (pen) icon, make the necessary changes, and click Proceed.

Result

Your linked project is now active.

View synced test cases/test suites

To view your synced test cases/test suites, go to Tests > Test Cases/Test Suites.