Skip to main content

Installation

Get started with Unfold CI in 3 simple steps. No infrastructure setup required!

Prerequisites​

Before you begin, ensure you have:

  • ✅ GitHub account with admin access to repositories
  • ✅ A CI/CD pipeline with tests (GitHub Actions recommended)
  • ✅ Active test suite in any supported framework

That's it! No servers, no databases, no Docker required.

Step 1: Install the GitHub App​

From GitHub Marketplace​

  1. Visit the Unfold CI GitHub App

  2. Click "Install"

    • Choose your organization or personal account
    • Select repository access:
      • All repositories (recommended) - Monitor all current and future repos
      • Only select repositories - Choose specific repos to monitor

  3. Review Permissions

    Unfold CI requires these permissions:

    • Contents: Read & Write - To create pull requests with fixes
    • Pull requests: Read & Write - To manage fix PRs
    • Metadata: Read-only - To access repository information
    • Checks: Read-only - To monitor test results
    • Workflows: Read-only - To detect GitHub Actions runs

  4. Complete Installation

    • Click "Install & Authorize"
    • You'll be redirected to the Unfold CI dashboard
First Time Setup

After installation, it may take a few seconds for your repositories to sync. Refresh the dashboard if they don't appear immediately.

Step 2: Access the Dashboard​

  1. Login to Dashboard

    • Visit app.unfoldci.com
    • Click "Sign in with GitHub"
    • Authorize access to your GitHub account

  2. Verify Installation

    • You should see your repositories listed
    • Each repository shows current monitoring status
    • If repos are missing, click "Sync Repos" button

  3. Explore Your Dashboard

    • Health Score: Overall test suite reliability
    • Flaky Tests: Currently detected flaky tests
    • Recent Fixes: AI-generated PRs awaiting review
    • Analytics: Time saved, tests monitored, success rates

Step 3: Configure Repository Access (Optional)​

Adding More Repositories​

  1. From Dashboard

    • Click "Add Repository" button in top-right
    • Or navigate to repository settings in GitHub

  2. From GitHub

  3. Verify in Dashboard

    • Return to app.unfoldci.com
    • Click "Sync Repos" to refresh the list
    • New repositories should appear immediately

Removing Repositories​

  1. From GitHub

  2. Sync Dashboard

    • Return to dashboard
    • Click "Sync Repos"
    • Removed repositories will no longer appear

Verification​

Check Installation Status​

Your installation is successful if you can:

✅ See repositories in dashboard

✅ Repository shows "Active" status

  • Each repo has a status indicator
  • Green = Ready to monitor
  • Gray = Needs workflow configuration

✅ GitHub App appears in settings

What Happens Next?​

After installation:

  1. Webhook Setup (Automatic)

    • GitHub automatically configures webhooks
    • No manual configuration needed
    • Webhooks send events to our cloud platform

  2. Repository Sync (Automatic)

    • Your repositories sync to our platform
    • Historical test data begins analysis (if available)
    • You're ready to configure workflows

  3. Next Step: Configure GitHub Actions

    • Generate your API key
    • Add workflow to send test results
    • Start detecting flaky tests

Troubleshooting​

App Installation Failed​

Problem: Error during GitHub App installation

Solutions:

  • Check you have admin permissions on the repository/organization
  • Try installing in a personal repository first
  • Clear browser cache and try again
  • Contact support if error persists

Repositories Not Showing​

Problem: Dashboard shows "No repositories"

Solutions:

  1. Click "Sync Repos" button

    Dashboard → Top-right → "Sync Repos"

  2. Verify app installation

  3. Check repository access

    • Make sure you granted repository access during installation
    • If you selected "Only select repositories", verify they're checked

  4. Wait a moment

    • Initial sync can take 10-30 seconds
    • Refresh the dashboard page

Can't Login to Dashboard​

Problem: Unable to access app.unfoldci.com

Solutions:

  • Ensure you've installed the GitHub App first
  • Use "Sign in with GitHub" (not email/password)
  • Check your GitHub account has access to installed repos
  • Try incognito/private browsing mode
  • Clear cookies for app.unfoldci.com

Organization Installation Issues​

Problem: Can't install for organization

Solutions:

  • Verify you're an organization owner
  • Check organization settings allow GitHub Apps
  • Review OAuth App policies
  • Contact organization admin for permissions

Organization-Wide Installation​

For Teams and Enterprises​

  1. Install at Organization Level

    • Navigate to your organization on GitHub
    • Go to Settings → GitHub Apps
    • Install Unfold CI
    • Select "All repositories" for full coverage

  2. Manage Access

  3. Team Dashboard

    • All team members with repo access can view dashboard
    • API keys can be generated per repository or organization-wide
    • Access control managed via GitHub permissions

Uninstalling​

If you need to uninstall Unfold CI:

  1. From GitHub

  2. Data Retention

    • Historical data retained for 30 days (for re-activation)
    • After 30 days, all data permanently deleted
    • Export data before uninstalling if needed

  3. Re-installing

    • Simply install the app again
    • Previous configuration restored if within 30 days
    • No data loss during short uninstalls

Next Steps​

✅ Installation complete! Now:

  1. Configure GitHub Actions - Add workflow to send test results
  2. Generate API Key - Get your authentication key
  3. Quick Start - Complete setup in 5 minutes

Getting Help​