Skip to main content
Version: current

Jenkins Integration


Install the Katalon plugin on Jenkins

  1. Sign in to Jenkins.

    The Jenkins Dashboard page appears.

  2. Select Manage Jenkins on the left sidebar.

    The Manage Jenkins page appears as below.

    manage jenkins page

  3. Click Manage Plugins.

    The Plugin Manager page appears as below.

    jenkins plugin page

  4. Click on the Available tab.

  5. Search for the Katalon plugin.

    Katalon displays accordingly.

    jenkins search katalon plugin

  6. Select this Katalon plugin, then choose between Install without restart and Download now and install after restart to install it.

You have installed the Katalon plugin on Jenkins.

Configure Test Runs in Katalon TestOps

You must schedule test runs in Katalon TestOps before assigning this schedule to Jenkins for test executions. See: Schedule Test Runs.

  • Choose the Save Configurations option in the Schedule Test Run dialog to schedule Test Runs for Jenkins.

Integrate Katalon TestOps with Jenkins

  1. Sign in to Jenkins.

    The Jenkins's Dashboard page appears.

  2. Select New Item on the left sidebar.

    The page appears as below.

    jenkins new item page

  3. Select Freestyle project, then enter a name for your project.

  4. Click OK.

    You will be navigated to your project's page as below.

    jenkins create project

  5. Click on the Build tab.

    You will be navigated to the Build section.

  6. Click Add build step, then select Execute Katalon TestOps Plan from the dropdown menu.

    jenkins build

    The new Execute Katalon TestOps Plan dialog will appear under Build.

  7. Fill in the required information.

    jenkins build

    • In the Server URL section, enter

    • In the Credentials section, click Add > Jenkins to add a new credential.

      The Add Credentials dialog appears as below.

      jenkins add credentials

      • In the Kind section, select Secret Text from the dropdown list.
      • In the Secret section, enter a Katalon TestOps API Key. See: API Keys.
      • In the ID section, give a name for the new credential (e.g., katalon-api-key-test).
      • Click Add to finish.

        You have added a new credential.

        You will be automatically navigated back to the Credentials section, where you can select the newly-added credential in the - none - box.

  8. Click Test Connection for Jenkins to retrieve Projects and Test Runs from Katalon TestOps.

    jenkins add credentials

    • If the test connection is successful, you will see Success! on the screen (highlighted in the image above).
  9. Select your project and the schedule you have created earlier. See: Configure Test Runs in Katalon TestOps.

  10. Click Save.

    You will be navigated back to the Jenkins Dashboard page.

  11. Select Build Now on the left sidebar to run the job.

    jenkins add credentials