Github integration

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

requirements

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 for more information.

Connect a Github account to TestOps

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

---

To set up the connection:

1. Go to Admin Settings. (You can find Admin Settings at the upper right corner of the page).
2. Navigate to System > Integrations, then click + Create Integration.

3. In the Available Integration list, choose Github.

   Note: The green checked mark means the integration is currently available to use.

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.
6. Then, click Save.

Result

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

If the status initially shows as Inactive, reload the page to update the status to Active.

Configure a Github repository in Project Level

Once an Account Admin or System Admin set 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 your Project-level UI > Settings > Integrations .

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

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 Github repository is now active within your project.

View synced test cases/test suites

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