Installation

Get started with UnfoldCI in three steps.

Prerequisites

Before you begin, ensure you have:

• GitHub account with admin access to repositories
• A CI/CD pipeline using GitHub Actions
• Tests that output JUnit XML format results

Step 1: Install the GitHub App

From GitHub

1. Visit the UnfoldCI GitHub App

   Go to github.com/apps/unfoldci-flaky-test-autopilot

2. Click "Install"

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

3. Complete Installation

   • Click "Install"
   • You'll be redirected to the UnfoldCI dashboard

tip

After installation, repositories sync automatically. Click "Sync Repos" in 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"
   • If you haven't installed the app yet, you'll be redirected to install it

2. Verify Installation

   • Your repositories should appear on the dashboard
   • Click "Sync Repos" to refresh the repository list

Step 3: Generate API Key

1. Navigate to Settings

   • Click the "Settings" button in the dashboard header

2. Generate New Key

   • Click "Generate New API Key"
   • Give it a descriptive name (e.g., "CI Pipeline Key")
   • Click "Generate"

3. Copy Your Key

   unfold_ci_abc123def456...

Save Your API Key

The key is only shown once. Copy it immediately and store it as a GitHub Secret.

Key Scope

API keys are scoped to your GitHub App installation. A single key works for all repositories within that installation.

Understanding Repository Visibility

How It Works

UnfoldCI shows repositories based on where you've installed the GitHub App. The dashboard displays all repositories from all your installations.

Installation Scope

When you install the UnfoldCI GitHub App, you choose where to install it:

Installation Type	What You See in Dashboard
Personal Account	Your personal repositories
Organization	Selected organization repositories
Both	All repos from both installations

Key Concept

Each installation (personal or organization) has its own installation_id. Your API key works for all repositories within a single installation.

Multiple Installations

You can install UnfoldCI on multiple accounts simultaneously:

Your Dashboard
├── Personal Account (installation_id: 12345)
│   ├── your-username/repo-1
│   └── your-username/repo-2
│
└── Your Organization (installation_id: 67890)
    ├── your-org/project-a
    └── your-org/project-b

All repositories from all your installations appear in a unified dashboard view.

Who Sees What?

Role	Visibility
Individual Developer	Repos from their personal install + any orgs they belong to
Org Member	All repos the org has granted access to
Org Admin	Can configure which repos are monitored

Team Visibility

When UnfoldCI is installed on an organization, all members of that organization can see the organization's repository data in their dashboards (when signed in with their GitHub account).

Managing Repositories

Adding More Repositories

From the Same Account/Organization:

1. Go to Settings → Applications → Installed GitHub Apps
2. Click "Configure" next to UnfoldCI
3. Select additional repositories
4. Save changes
5. Return to dashboard and click "Sync Repos"

From Dashboard (Quick Access):

1. Click "Add Repository" button
2. You'll be redirected to GitHub's installation settings
3. Select additional repositories
4. Return to dashboard and click "Sync Repos"

From a Different Organization:

1. Visit github.com/apps/unfoldci-flaky-test-autopilot
2. Click "Install"
3. Select the new organization
4. Choose which repositories to monitor
5. Complete installation
6. New repos will appear in your dashboard

API Keys Per Installation

If you install UnfoldCI on a new organization, you'll need to generate a separate API key for that installation. Each installation has its own API key.

Removing Repositories

1. Go to GitHub Settings → Applications
2. Click "Configure" next to UnfoldCI
3. Uncheck repositories to stop monitoring
4. Save changes

Removed repositories are archived in the dashboard. Historical data is preserved.

Uninstalling

To uninstall UnfoldCI:

1. Go to Settings → Applications → Installed GitHub Apps
2. Click "Configure" next to UnfoldCI
3. Scroll down and click "Uninstall"

Your historical data is retained and can be restored if you reinstall.

Next Steps

After installation:

1. Configure GitHub Actions — Add the UnfoldCI action to your workflow
2. Quick Start — Complete end-to-end setup guide