GitHub Integration

​

Overview

• Repository linking - Connect repos to track commits and branches
• Build tracking - Associate builds with specific commits and branches
• CI/CD automation - Trigger tests on pull requests, pushes, and merges
• Status reporting - Post test results directly to GitHub PRs

​

Setup Guide

​

Prerequisites

• A GitHub account with access to an organization or personal repos
• Admin or write access to repositories you want to test
• Owner/Admin permissions in the GitHub organization (for OAuth app installation)

​

Step 1: Connect Your GitHub Organization

1. Navigate to Integrations in the Revyl sidebar
2. The GitHub Organizations tab is selected by default
3. Click Connect GitHub Organization
4. You’ll be redirected to GitHub’s authorization page
5. Select the organization (or use your personal account)
6. Choose which repositories to grant access:
   • All repositories (current and future)
   • Only select repositories (pick specific repos)
7. Click Install & Authorize
8. You’ll be redirected back to Revyl with a success message

​

Step 2: Configure a Repository

1. Click Add Repository in the Repository Configuration section
2. The configuration popup appears with these options:

• On Pull Request Open - Run tests when a PR is created
• On Pull Request Update - Run tests when a PR is updated
• Manual Trigger - Enable @revyl bot commands in PR comments

​

Step 3: Enable Manual Trigger (Optional)

1. Open the repository configuration
2. Check the Manual Trigger checkbox under Trigger Events
3. Click Create Configuration or Update Configuration

​

What Can You Do With GitHub Integration?

​

1. Commit-Based Build Tracking

• Branch name - e.g., main, develop, feature/login
• Commit SHA - e.g., abc1234
• Build metadata - Revyl tracks which builds came from which commits

• Trace bugs to specific commits
• Know exactly which code version is being tested
• See build history correlated with Git history

​

2. Pull Request Testing

1. Developer opens a PR
2. GitHub Actions workflow triggers
3. Revyl runs the test suite on the PR’s build
4. Results are posted as a commit status on the PR
5. Team sees pass/fail status before merging

• ✅ Revyl Tests: All tests passed (12/12)
• ❌ Revyl Tests: 2 tests failed (10/12)
• ⏳ Revyl Tests: Running...

​

3. Branch-Specific Workflows

• Main branch: Full regression suite (all tests)
• Develop branch: Smoke tests (critical paths only)
• Feature branches: Relevant feature tests

​

4. CI/CD Pipeline Integration

# .github/workflows/test.yml
name: Test on Pull Request

on:
  pull_request:
    branches: [main, develop]

jobs:
  revyl-test:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Revyl Test
        env:
          REVYL_API_KEY: ${{ secrets.REVYL_API_KEY }}
          REVYL_WORKFLOW_ID: ${{ secrets.REVYL_WORKFLOW_ID }}
        run: |
          curl -X POST https://api.revyl.ai/v1/workflows/$REVYL_WORKFLOW_ID/run \
            -H "Authorization: Bearer $REVYL_API_KEY"

​

PR Comment Commands

​

Available Commands

​

Command Examples

@revyl

@revyl config run

@revyl config run ios:https://expo.dev/artifacts/... android:https://expo.dev/artifacts/...

@revyl run workflows 1,2,3

​

PR Open Trigger Behavior

​

How It Works

1. PR is opened on a connected repository
2. Revyl checks the diff - Compares changed files against configured build paths
3. Decision is made:

• Uses existing builds already in Revyl
• Runs configured workflows automatically
• No user action needed

• Shows a help message in the PR
• Prompts you to provide new build URLs
• Waits for you to run @revyl config run ios:URL android:URL

​

Example Flow

PR opened with changes to:
├── apps/expo-demo/src/App.tsx    ← In build path
├── apps/expo-demo/package.json   ← In build path
└── README.md                      ← Not in build path

Result: Build path changed → Revyl comments asking for new build URLs

PR opened with changes to:
├── docs/README.md                 ← Not in build path
└── scripts/deploy.sh              ← Not in build path

Result: No build changes → Runs tests with existing builds automatically

​

Managing GitHub Integration

​

Viewing Connected Organizations

1. Go to Integrations → GitHub Organizations
2. If connected, you’ll see organization details (name, avatar)
3. You’ll see a list of repositories you’ve granted access to

​

Adding More Repositories

1. Go to Integrations → GitHub Organizations
2. Click Manage Repositories (if available) or Configure on GitHub
3. You’ll be taken to GitHub’s app settings
4. Select additional repositories
5. Click Save
6. Return to Revyl - new repos will appear in the CI/CD Integration dropdown

​

Removing Repository Access

1. Go to your GitHub organization’s Settings → Installed GitHub Apps
2. Find Revyl in the list
3. Click Configure
4. Deselect repositories you want to remove
5. Click Save

​

Disconnecting GitHub

1. Go to Integrations → GitHub Organizations
2. Click Disconnect GitHub (if available)
3. Confirm disconnection

1. Go to your GitHub organization’s Settings → Installed GitHub Apps
2. Find Revyl and click Configure
3. Scroll down and click Uninstall

​

Permissions & Security

​

What Permissions Does Revyl Request?

​

What Can Revyl NOT Do?

• Modify your code or files
• Push commits
• Merge pull requests
• Access private information beyond repositories
• Delete branches or repositories

​

Data Privacy

• Commit SHAs and messages
• Branch names
• Pull request metadata (title, number, status)

• Source code contents
• Credentials or secrets
• Personal developer information

​

Troubleshooting

​

”No repositories found” in CI/CD Integration

1. Go to GitHub Organizations tab
2. Verify connection status shows “Connected”
3. If connected, click Configure to manage repository access on GitHub
4. Grant access to at least one repository

​

GitHub Action Not Triggering Tests

1. API Key is correct
   • Verify REVYL_API_KEY secret is set in GitHub repo settings
   • Generate a new API key in Revyl if needed (Settings → API Keys)
2. Workflow ID is correct
   • Double-check the workflow ID in your GitHub Action matches the one in Revyl
3. Workflow is triggered correctly
   • Verify the GitHub Action is running (check Actions tab)
   • Check logs for errors in the curl request

​

Commit Status Not Appearing on PR

1. Revyl doesn’t have permission
   • Verify “Commit statuses” permission is granted (re-install app if needed)
2. Wrong repository linked
   • Check that the correct repo is selected in CI/CD Integration tab
3. Test hasn’t completed yet
   • Commit status only appears after test finishes
   • Check Revyl test history to see if test ran

​

Re-authorizing GitHub

1. Go to Integrations → GitHub Organizations
2. Click Disconnect GitHub
3. Click Connect GitHub Organization again
4. Re-authorize and select repositories

​

Best Practices

​

Repository Organization

• Workflow 1: android-app-tests (tests Android build)
• Workflow 2: ios-app-tests (tests iOS build)

​

Branching Strategy

• main / master: Full test suite before merging
• develop / staging: Smoke tests for quick feedback
• Feature branches: Tests related to the feature

​

Commit Messages

feat: Add login screen (#123)

Tested with Revyl workflow: login-flow-test

​

Protected Branches

1. Go to repo Settings → Branches
2. Add rule for main branch
3. Enable: Require status checks to pass before merging
4. Select: Revyl Tests

​

Next Steps

• Set up GitHub Actions →
• Trigger tests via API →
• Configure workflows →
• View CI/CD pipeline in Builds →