Skip to main content
Version: current

Git integration in Katalon Studio - Platform Edition

In Katalon Studio - Platform Edition, Git integration is always enabled by default. You cannot disable Git integration in Katalon Studio - Platform Edition.

A Git repository URL is required when you open a project in Katalon Studio. See Open a project in Katalon Studio - Platform Edition.

You can view your Git repository URL in Project Information. See Project Information in Katalon Studio - Platform Edition.

This document shows you how to work with Git in Katalon Studio - Platform Edition.

Log in to Git account in Katalon Studio Platform Edition

In case your Git personal access token expires, you can update the new token for using Git integration in Katalon Studio Platform Edition. Do as follows:

  1. Click on the dropdown of the Profile icon and choose Log in to Git.
  2. In the Log in to Git dialog, enter your Git Username and Git Personal Access Token.
    Granting the Write permission for this token is recommended. You can click Save authentication to remember this credentials for the next time opening this project.
  3. Click Log in.
You've successfully updated your Git personal access token in Katalon Studio.

Set remote connection timeout for Git

To set remote connection timeout for Git in Katalon Studio - Platform Edition, do as follows:
  1. From the main menu, go to Preferences > Katalon > Git.
  2. Enter the amount of time in second for remote connection timeout.
  3. Click Apply.

Commit

The Commit option allows users to view all current changes and decide which changes are stored in the local branch. For more information on the commit command, refer to this Git document: Commit.

  1. In the main toolbar, click on Git > Commit.

  2. The Git Staging tab is displayed for configuration.

    Git stagging

    FieldDescription
    Unstaged ChangesChanges which have been made.
    Staged ChangesSelected changes from Unstaged Changes. These changes are committed.
  3. From the Unstaged Changes list, select the changes to be committed, then right-click on them and select Add To Index. Selected changes are added to the Staged Changes list.

  4. Enter your comments into the Commit Message, then click on Commit to store your staged changes into the local branch.

Manage Branches

New Branch

  1. In the main toolbar, click the Git icon > Manage Branches > New Branch.

  2. The Create Branch dialog displays.

    create branch

    FieldDescription
    Source

    Select either remote or local branch, which is your source branch.

    Select Source

    Branch nameThe name to be used for the new branch.
    Checkout new branchOption to let Katalon Studio checkout that branch after created.
  3. Click Finish to create a new branch.

Checkout Branch

The Checkout Branch option allows you to switch from one branch to another.

  1. In the main toolbar, click the Git icon > Manage Branches > Checkout Branch.

  2. The Select Source dialog displays. Select the local branch you want to check out to be the current branch. The branch with an icon is your current local branch.

    select source

  3. Click OK to finish checking out to the new local branch.

Delete Branch

  1. In the main toolbar, click the Git icon > Manage Branches > Delete Branch.

  2. In this dialog, both local and remote branches are displayed. Select a branch to be deleted, then click OK.

    delete branch

Fetch

Retrieve all information about changes that have occurred in remote branches. For more information on the fetch command, refer to the Git documentation: Git Fetch.

  1. In the main toolbar, click on Git > Fetch.

  2. Remote branches, tags, and remote changes are fetched automatically.

    git fetch result

  3. In the main toolbar, click Show History.

  4. Details regarding all the branches and tags you've just fetched are displayed.

    history

Pull

Incorporate changes from a remote repository into the current branch. For more information on the pull command, refer to the Git documentation: Git Pull.

  1. In the main toolbar, click the Git icon > Pull. The Pull dialog appears.

  2. In the Pull dialog, select the remote branch to be pulled into your local branch. Click Finish.

    pull

  3. The Pull Result dialog displays all data about pulling requests on the selected branch.

    pull result

Push

Update the remote branch using the local branch. For more information on the push command, refer to the Git documentation: Git Push.

Before doing any push, you have to commit your changes first.

  1. From the main toolbar, select Git > Push.

  2. The Push to Branch dialog is displayed. Choose from the Remote branch list which branch to be updated (All remote branches in your Git repository are listed here).

    push branch

    Click Next after finishing selecting your remote branch. The Push Confirmation dialog appears.

    Note:
    • If you enter a different name besides the listed branches, a new remote branch with that name is created accordingly.

  3. The Push Confirmation dialog displays details regarding your commit.

    push branch

    Click on Finish to push your commits to the remote repository.