GitHub Actions

Overview

Verex integrates with GitHub Actions to help you automatically run test suites as part of your CI/CD workflows. This GitHub Action makes it easy to trigger tests, wait for completion, and surface results directly in your pipeline.

View GitHub Repository

Features

• Run Verex test suites from any GitHub workflow
• Automatic polling and real-time test monitoring
• Output test result summaries and metadata
• Pass dynamic URLs to target specific environments
• Debug mode for troubleshooting

Quick Start

1. Add to Your GitHub Workflow

- name: Run QA Tests
  uses: verex-ai/github-test-runner@v1
  with:
    api_key: ${{ secrets.VEREX_API_KEY }}
    test_suite: 'suite_abc123456'

2. Set Up Your API Key

• Create your API Key in the Verex Dashboard under Settings > API Keys
• Add it to your GitHub repository secrets as VEREX_API_KEY

Complete Example

- name: Run QA Tests
  uses: verex-ai/github-test-runner@v1
  with:
    api_key: ${{ secrets.VEREX_API_KEY }}
    test_suite: 'testsuite_123456'
    debug: 'true'
  id: test_results
 
- name: Report Test Results
  if: always()
  run: |
    echo "Passed: ${{ steps.test_results.outputs.passed_tests }}"
    echo "Failed: ${{ steps.test_results.outputs.failed_tests }}"

Dynamic Base URL

To run tests against a dynamic environment (e.g. your current deploy preview), you can pass a custom base URL:

test_base_url: ${{ steps.deploy.outputs.deployment_url }}

This value replaces any {{base_url}} placeholder used in your Verex test suite.

Inputs

Outputs

Requirements

• A Verex account
• A valid API Key with permissions to run test suites

Troubleshooting

Enable debug: true to view detailed logs in case of:

• Invalid API keys
• Test suite not found
• Timeout issues
• Connectivity problems

Resources

• API Keys Documentation
• Running Tests via API
• Pipeline Integrations Overview

Need help? Contact Support