Skip to main content

Katalon Studio GitHub Action

Use Actions on GitHub to automate your development workflow. The Katalon Studio GitHub Action available on the GitHub marketplace allows you to automate your Katalon Studio project execution. Access Katalon Studio GitHub Action from GitHub marketplace: Katalon Studio GitHub Action.

Requirements​

  • You need an active Katalon Runtime Engine (KRE) license.
  • You must be on Katalon Studio version 7.0.0 or later.

  • You have already set up your Katalon API key using a GitHub encrypted secret named API_KEY. To learn how to use Katalon API keys, see Katalon API Keys. To learn more about GitHub encrypted secrets, see GitHub document Encrypted secrets.

Variables​

To run the Katalon Studio GitHub Action, define the variables in the action metadata file.

Below is an example of how the action metadata file looks like. You do not need to create action metadata files when using Katalon Studio GitHub Action:

name: 'Katalon-Studio'
description: 'Execute Katalon Studio projects'
inputs:
      version:
            description: 'Which version of Katalon Studio to run'
            required: true
            default: ''

      projectPath:
            description: 'Where the Katalon Studio project is checked out'
            required: true
            default: ''

      args:
            description: 'What arguments to run Katalon Studio project'
            required: true
            default: ''

runs:
      using: 'node16'
      main: 'index.js'

Example usage​

Use the following script below to execute a Katalon Studio test suite collection from GitHub Actions:

name: CI
on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: windows-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v3.0
    - name: Katalon Studio Github Action
      uses: katalon-studio/katalon-studio-github-action@v3.0
      with:
          version: '7.5.5'
          projectPath: '${{ github.workspace }}'
          args: '-noSplash -retry=0 -testSuiteCollectionPath="Test Suites/Simple Test Suite Collection" -apiKey= ${{ secrets.API_KEY }} --config -webui.autoUpdateDrivers=true'

You can find the CI samples for macOS and Windows on our GitHub repository. See ci-samples/.github/workflows/.