Configure a Git repository in TestOps

Important:

Git repository configuration is a prerequisite step for scheduling or executing a test. Alternatively, you could also upload your own script repository.

Katalon Platform supports connecting a Git repository to Katalon TestOps. This allows you to perform version control on test cases and test suites between different modules in Katalon Platform.

Katalon supports the following integrations for Git repositories:

• AWS CodeCommit

• Azure Repos

• Bitbucket

• GitHub

• GitLab

This article demonstrates how to configure a Git repository in Katalon TestOps.

Configure a Git repository in TestOps

• You have an existing test project in Azure Repos / Bitbucket / GitHub / GitLab / AWS CodeCommit.

To can configure your Git repository from TestOps Script Repositories page within Settings. For a step-by-step breakdown, see below.

1. Go to your TestOps project and click Settings.
2. Click Script Repositories > Connect Git Repository. Then click Create a new Git repository.
   
3. In the Source Type dropdown list, choose one of the following source types:
   • Azure Repos
   • Bitbucket
   • GitHub
   • GitLab
   • AWS CodeCommit. When you select the AWS CodeCommit option, the Access Key ID and Secret Access Key fields are enabled.
4. In the Repository URL field, enter the URL of your Git script repository. If you choose AWS CodeCommit, you can refer to this AWS document to retrieve the repository URL: Step 4: Connect to the CodeCommit console and clone the repository.
5. In the Username field, enter your Azure Repos / Bitbucket / GitHub / GitLab / AWS CodeCommit username.
6. In the Personal Access Token field, enter your personal access token (PAT). To create a PAT, you can refer to the following documents:
   • For Azure Repos, see this Microsoft document: Use personal access tokens.

   • For Bitbucket, refer to this Atlassian document: Create an App password.

   • For GitHub, see this GitHub document: Creating a personal access token. Make sure you opt to create a classic PAT, and select repo scope to set permission scopes for the PAT.

   • For GitLab, refer to this GitLab document: Personal access tokens.

   • For AWS CodeCommit, to create username and PAT for Git credentials, refer to this AWS document: Step 3: Create Git credentials for HTTPS connections to CodeCommit.

7. In the Access Key ID and Secret Access Key fields, enter your access key ID and secret access key in AWS CodeCommit. To retrieve the access key ID and secret access key, you can refer to this AWS document: Manage access keys for IAM.
8. Optional: You can choose Link existing test execution results with test cases having the same paths and names. This option allows TestOps to attach existing test run results to the uploaded test cases and test suites that has the same paths and names.
   For example:

   • You have an existing test run results from the Login test case in the Test Cases/Common Test Cases folder. By default, if this test case is not from an uploaded Git test project, its test results are in the Uploaded Data folder in the Test Management tab.

   • You upload a Git repository that also has a Login test case in the Test Cases/Common Test Cases folder.

   • You check the Link existing test execution results with test cases having the same paths and names option.

   • Once the Git repository is connected successfully, in the Test Management tab, you can see the existing test results of the Login test case in the <your-git-repo-name>/Test Cases/Common Test Cases folder.

9. Click Connect.

   The following sections appear:

   • Branch: choose a branch.
   • Name: enter your project name.
   • Target Directory: If your project and its files are in a sub-directory within the Git repository, you can specify its location.
   • Description: enter your Git project description (optional).
10. Click Create.

You have successfully connected a Git repository to Katalon TestOps. Next, you can start managing your test scripts in Katalon TestOps.

Sync your Git repository latest versions to Katalon TestOps

You must have Configured a Git Repository on TestOps.

You can ensure that your repository is up to date by clicking on Refresh Script Repository within the Script Repository's page to force a synchronization. For a step-by-step breakdown, see below.

1. Go to your TestOps project and click Settings > Script Repositories.
2. Select the Git repository you want to sync from the list.
3. Sync the latest version of your Git repository by clicking Refresh Test Suite Collection.
   

The latest version of your Git repository has been synced to Katalon TestOps.