Github integration

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

requirements

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

Connect a Github account to TestOps

You must have the Account Admin or System 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.

   ✅ A green check mark indicates that the integration is currently available.

   

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

   • Integration Name: A custom name for the integration (max 50 characters).
   • Organization Account URL: The Github Organization URL that starts with https://.
     • Example: https://github.com/your-group-name
   • Github Personal Access Token: To generate a PAT, refer to this GitHub documentation on creating a personal access token.
   • Description (Optional): A brief description of the integration (max 255 characters).

5. Click Test Connection to validate the integration.
6. Once validated, click Save, or click Cancel to exit without saving any changes.

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.
• If the status shows Error, verify all required configuration fields, especially the Personal Access Token (PAT), and confirm it is valid and configured correctly in the account-level integration.

Configure Github integration at the Project level

warning

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 specific project's UI > Settings > Integrations.

2. Click the right edge of your linked connection and select New configuration (Setting icon).

3. Fill in the required fields:

• Display Name: A custom name for the linked project (max 50 characters).
• URL: The URL to the desired repository, branch, or directory from the linked Github account. Copy and paste the URL into this field.
  • For example: If you linked a connection under https://github.com/katalon-studio, then the URL should look like:
    https://github.com/katalon-studio/katalon-repo/tree/main/Test%20Cases
• (Optional) Select Link existing test execution results with test cases having the exact same paths and names to enable attaching existing test run results to test cases and suites with matching paths and names in TestOps.
• (Optional) Description: Brief description about the linked project (max 255 characters).

4. Click Proceed to sync data and finalize the connection.

   • 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, your changes will be saved, but the status may remain Inactive. To sync data and finalize the connection, click Proceed.

5. [Optional] To edit an existing linked Github integration, click the Edit (pen) icon, make the necessary changes, and click Proceed. After editing, reload the page to ensure data is refreshed.

Result

Your Github repository is now active within your project.

View test cases or test suites synced from linked GitHub integration

To view test cases or test suites synced from the linked GitHub integration, navigate to Tests > Test Cases/Test Suites.

Archive a linked Github integration

You must have the Project Admin role to perform this action.

info

When an integration is archived:

• The status changes to Archived.
• The integration no longer appears in the Test Cases/Test Suites module.
• Any scheduled test runs in the Execution module will be automatically canceled at runtime.

To archive a linked Github integration:

1. Navigate to your specific project's UI > Settings > Integrations.
2. Click the right edge of your linked connection and select Archive icon.

3. A confirmation dialog will appear. Click Archive if you want to move forward.

Unarchive a linked Github integration

You must have the Project Admin role to perform this action.

info

After you unarchive an integration:

• The status might appear as Inactive. Reload the page to update it to Active.
• If the status shows Error, verify all required configuration fields and make necessary corrections.

To unarchive a linked Github integration:

1. Navigate to your specific project's UI > Settings > Integrations.
2. Click the right edge of your linked connection and select Unarchive icon.
   
   
3. A confirmation dialog will appear. Click Unarchive if you want to move forward.