GitHub Integration

This document explains how to set up and manage a GitHub integration in Katalon True Platform.

Connect GitHub to Katalon True Platform to sync test cases and test suites between the two systems.

Find your starting point:

• You are setting up GitHub for the first time? → Start from Step 1
• Your org is already connected and you just need to link a repository? → Skip to Step 2
• You just need to push your edits on Katalon True Platform back to GitHub? → Skip to Step 3

---

Step 1: Authorize the GitHub Connection (Account-level)

This step establishes the connection between Katalon True Platform and GitHub. No data is synced yet.

requirements

• You must have the Account Admin or System Admin role in Katalon True Platform to perform this action.
• The Personal Access Token (PAT) must be created by a user with full access to all repositories in the GitHub organization. If using a PAT with limited permissions may cause errors when integrating repositories at the project level.

1. Go to Account Settings > Integrations and click + Create Integration.

2. In the Available Integration list, select GitHub.

3. Fill in the required fields:

   • Integration Name: a custom label (max 50 characters).

   • Organization Account URL: your GitHub org URL, e.g. https://github.com/your-org-name.

   • Github Personal Access Token: To generate a PAT, refer to this GitHub documentation on creating a personal access token.

     PAT Permission Requirements

     This PAT is also used to automatically create GitHub webhooks during project-level setup, so webhook permissions are required.

     Fine-grained PAT

     • Read & Write → Contents
     • Read access → Metadata
     • Read & Write → Webhooks

     

     Classic PAT

     • Must be created by a repository Admin
     • Must grant full permissions for the repo scope

   • Description (Optional): Max 255 characters.

4. If connecting to GitHub Enterprise Server or a self-managed instance, fill in the same fields above.

Supported version: GitHub Server 3.13.16 and above. You can optionally configure a Cloud Tunnel for local testing. See Local testing with Test Execution - Cloud in Katalon True Platform for steps to install the agent, generate tunnel, and manage tunnel availability.

5. Click Test Connection to validate, then Save.

Result

To verify if the connection is active, navigate to Account Settings > 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.

---

Step 2: Link Repository to Project (Project-level)

This step shows how to connect a specific GitHub repository/branch to your Katalon True Platform project and sync test data.

requirements:

• You are the Project Admin of this project. Account Admins and System Admins without the project's Project Admin role cannot configure this.
• A GitHub account must already be connected at the Account-level (Step 1)
• For Github Enterprise repositories, your Github account needs to have an admin role within that repository.

1. Navigate to your specific project's UI > Settings > Integrations.

2. On your linked GitHub connection, click the right edge and select New configuration (Settings 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
• Link existing test execution results with test cases having the exact same paths and names (Optional): Enable this if you want Katalon True Platform to automatically attach existing test results to test cases and test suites whose paths and names match your GitHub structure.
• Description (Optional): A brief description of this linked project (max 255 characters).

4. Click Proceed to sync data and finalize the connection. Katalon True Platform automatically syncs your project with the GitHub repository.

   • A GitHub webhook is created automatically, enabling real-time updates such as test results and GitHub action triggers.
   • If webhook creation succeeds → The integration status updates to Active.
   • If webhook creation fails → The status shows Inactive, with an error message: "Failed to create GitHub webhook. Please try again." You can retry by clicking Proceed again once the issue is resolved.

   Additional behavior:

   • 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 changes are saved, but the status may remain Inactive. To sync data and finalize the connection, you must 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 and test data has been synced from GitHub to Katalon True Platform.

---

Step 3: Enable Updates to GitHub

This step is only required if you edit test cases in Katalon True Platform and want those changes to sync to GitHub. Each user must complete this setup individually.

Before enabling sync from Katalon True Platform to GitHub, ensure that:

• GitHub is connected at the account level (Step 1)
• A repository is linked at the project level (Step 2)
• You have write permissions for the repository in GitHub

By default, changes you make in Katalon True Platform (such as priority, assignee, or structure) remain local. To push these changes back to GitHub, you need to provide your own Personal Access Token (PAT). Katalon True Platform uses this token to sync changes on your behalf.

1. Go to User Settings > Personal Integration.
2. Click the settings icon next to the integration you want to configure.
3. Enter your User Email and GitHub Personal Access Token (PAT).
4. Click Save.

Once saved, any edits you make to artifacts in linked repositories within Katalon True Platform will automatically sync back to GitHub.

---

View Test Cases or Test Suites Synced from GitHub

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

---

Managing Your GitHub Integration

Katalon True Platform provides multiple ways to manage GitHub integrations without losing historical data. This section covers how to disconnect, archive, and restore an integration when needed.

• Use Disconnect to disable the GitHub integration across all projects (Account-level)
• Use Archive to disable a GitHub connection for a single project (Project-level)

Disconnect a Github Connection

Required role: Account Admin or System Admin to perform this action.

Disconnecting makes the integration inactive across all projects. Katalon True Platform does not support fully deleting integrations, in order to preserve audit history.

1. Go to Account Settings > Integrations.

2. Click the Disconnect icon next to the connection.

3. Confirm by clicking Disconnect in the dialog.

   => The status changes to Inactive. All projects using this integration lose the ability to sync with GitHub.

4. To reconnect, click the Reconnect icon next to the integration and confirm. All projects will resume syncing once reconnected.

Archive a Linked Repo

Required role: Account Admin or System Admin to perform this action

Archiving disables the connection for that project only — other projects using the same GitHub integration are unaffected. Archived configurations no longer appear in Project Settings, and any scheduled test runs will be canceled at runtime.

1. Go to your project's Settings > Integrations.
2. Click the right edge of your linked connection and select Archive.
3. Confirm by clicking Archive in the dialog.

=> 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.

Restore an Archived Integration

1. Go to your project's Settings > Integrations.
2. Click New configuration (settings icon) on the GitHub connection.
3. Enter the same repository URL as the archived configuration and click Proceed.

Katalon True Platform will restore the archived configuration rather than creating a duplicate.