Skip to main content

​
Overview

Revyl provides powerful CI/CD integration capabilities that allow you to run automated tests as part of your continuous integration and deployment workflows. By integrating Revyl with your CI/CD pipeline, you can:
  • Run tests automatically on every pull request or commit
  • Catch bugs early before they reach production
  • Maintain quality gates by failing builds when tests fail
  • Scale testing across multiple platforms and devices
  • Get instant feedback on code changes

​
How CI/CD Integration Works

Revyl’s CI/CD integration is built on a simple API-based approach:
  1. Generate an API Key - Create a personal or organization API key for authentication
  2. Configure Your Pipeline - Add Revyl to your CI/CD workflow (GitHub Actions, GitLab CI, etc.)
  3. Trigger Tests - Execute tests or workflows via the Revyl API
  4. Receive Results - Get pass/fail status and detailed workflow reports

​
Getting Started

​
Step 1: Generate an API Key

API keys are used to authenticate your CI/CD pipeline with Revyl. You can create either:
  • Personal API Keys - Associated with your user account
  • Organization API Keys - Shared across your team
Recommendation: Use a Personal API Key for CI/CD integration. Personal keys are tied to your account permissions and are easier to manage and rotate.

​
Creating a Personal API Key

  1. Navigate to Account → Personal API Keys
  2. Click New API key
Empty API Keys page
  1. Select an expiration period for the key:
    • Two weeks
    • One month
    • Three months
    • Six months
    • One year
    • Never (not recommended for security)
API Key creation dialog Expiration options
  1. Click Create
  2. Copy your API key immediately - This is the only time you’ll be able to view it!
API Key created successfully
  1. Store the key securely (e.g., in your CI/CD secrets manager)
API Keys list with created key
  • Never commit API keys to version control - Use your CI/CD platform’s secrets manager (GitHub Secrets, GitLab CI/CD Variables, etc.) - Rotate keys periodically for enhanced security - Use organization keys for team projects - Set appropriate expiration periods based on your security requirements

​
Step 2: Get Your Test or Workflow ID

You’ll need the ID of the test or workflow you want to run in CI/CD.

​
Finding Workflow IDs

  1. Go to Workflows
  2. Hover over a workflow card, then click the three dot menu button
  3. Click Copy ID

​
Step 3: Configure Your CI/CD Pipeline

Revyl provides integrations for popular CI/CD platforms:
  • GitHub Actions - Official Revyl GitHub Action
  • GitLab CI - Use the Revyl API directly
  • Jenkins - Use the Revyl API directly
  • CircleCI - Use the Revyl API directly
  • Any other platform - See API Reference

​
Running Tests via API

For direct API integration, see the API Reference for complete documentation on executing tests and workflows programmatically.

​
Common Use Cases

​
Pull Request Testing

Run tests automatically when a pull request is opened or updated: 
# GitHub Actions example
on:
  pull_request:
    branches: [main]

jobs:
  workflow:
    runs-on: ubuntu-latest
    steps:
      - name: Run Revyl Workflow
        uses: RevylAI/revyl-gh-action/run-workflow@main
        env:
          REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
        with:
          workflow-id: "your-workflow-id"

​
Nightly Regression Testing

Schedule workflows to run overnight: 
# Run every night at 2 AM
on:
  schedule:
    - cron: "0 2 * * *"

jobs:
  regression:
    runs-on: ubuntu-latest
    steps:
      - name: Run Full Regression Suite
        uses: RevylAI/revyl-gh-action/run-workflow@main
        env:
          REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
        with:
          workflow-id: "regression-workflow-id"

​
Pre-Deployment Validation

Run smoke tests before deploying to production: 
# Before deployment
jobs:
  smoke-workflow:
    runs-on: ubuntu-latest
    steps:
      - name: Run Smoke Tests
        uses: RevylAI/revyl-gh-action/run-workflow@main
        env:
          REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
        with:
          workflow-id: "smoke-workflow-id"

  deploy:
    needs: smoke-workflow
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to Production
        run: ./deploy.sh

​
Retries and Error Handling

Configure retry behavior for flaky tests: 
- name: Run Tests with Retry
  uses: RevylAI/revyl-gh-action/run-workflow@main
  env:
    REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
  with:
    workflow-id: "your-workflow-id"
    retries: 3 # Retry up to 3 times on failure

​
Monitoring and Notifications

Combine Revyl with integrations for comprehensive monitoring:

​
Next Steps

Need help? Contact [email protected]