Skip to main content

Katalon Studio GitHub Action

You can use Actions on GitHub to automate your development workflow. With the Katalon Studio GitHub Action available on the GitHub marketplace, you can automate Katalon Studio project execution. Access from GitHub marketplace: Katalon Studio GitHub Action.

Requirements

  • An active Katalon Runtime Engine license.
  • Katalon Studio version 7.0.0 onwards.
  • You 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

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: 'node12'
main: 'index.js'

Usage Example

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

jobs:
build:
runs-on: windows-latest
steps:
- name: Checkout
uses: actions/checkout@v2.1
- name: Katalon Studio Github Action
uses: katalon-studio/katalon-studio-github-action@v2
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: ci-samples/.github/workflows/.