Skip to main content

Step 2: Install GitHub App

Install the diffray GitHub App on your account or organization to access repositories.

Why GitHub App?​

The GitHub App is a secure way to give diffray access to your repositories. Unlike the deprecated API keys and GitHub Actions method, GitHub App:

  • More Secure - works without personal access tokens
  • More Flexible - you choose specific repositories for access
  • More Modern - uses current GitHub mechanisms
  • Simpler - no secrets and Actions to configure

Installing GitHub App​

Via Dashboard​

  1. After signing in, go to Repositories section
  2. You'll see a prompt to install GitHub App (if not already installed)
  3. Click "Install GitHub App"

Via GitHub​

You can also install the app directly:

https://github.com/apps/diffray/installations/select_target

Installation Process​

  1. Choose Account/Organization

    • For personal projects, choose your account
    • For team projects, choose an organization (requires admin rights)

  2. Select Repositories

    You have two options:

    • All repositories - grant access to all current and future repositories
    • Only select repositories - choose specific repositories (recommended)

  3. Confirm Installation

    Click "Install" or "Install & Authorize"

  4. Return to diffray

    After installation, you'll be redirected back to diffray dashboard

What Permissions Does the App Request?​

diffray GitHub App requests the following permissions:

Read access​

  • Repository contents - read code for analysis
  • Pull requests - get PR information
  • Repository metadata - basic repository information

Write access​

  • Pull requests - post comments with review results
  • Checks - create and update GitHub Check Runs
  • Issues (via labels) - add/remove status labels

diffray CANNOT:

  • Modify your code
  • Create or delete branches
  • Merge pull requests
  • Change repository settings
  • Delete repositories

Installing for Organization​

If you're installing the App for an organization:

  1. Admin rights required for the organization
  2. After installation, all organization members with repository access can see reviews
  3. Organization admin can:
    • Add/remove repositories from App access
    • Uninstall the App at any time

View Organization Status​

In the Repositories section, you'll see a list of your organizations with indication:

  • ✓ App Installed - app is installed
  • Install App - button to install

Managing Installation​

Adding Repositories​

After installation, you can add more repositories:

  1. Go to GitHub: Settings → Applications → Installed GitHub Apps
  2. Find "diffray"
  3. Click "Configure"
  4. Select additional repositories

Removing Repositories​

  1. On GitHub: Settings → Applications → Installed GitHub Apps → diffray → Configure
  2. Deselect repositories you no longer need

Uninstalling App​

If you want to completely remove diffray:

  1. GitHub: Settings → Applications → Installed GitHub Apps
  2. Find "diffray"
  3. Click "Uninstall"

Warning: When uninstalling the App, diffray will lose access to all your repositories.

After Installation​

After successfully installing the GitHub App:

  1. In the Repositories section, click "Refresh" or "I've already installed it" button
  2. You'll see a list of available repositories from the installed App
  3. Next step: Add Repositories

Troubleshooting​

Don't see your repositories?​

Reason: App not yet installed or installed on different account

Solution:

  1. Make sure you installed the App on the correct account/organization
  2. Refresh the Repositories page in diffray
  3. Check that you selected repositories during installation (not "All repositories")

App installed but repositories don't appear?​

Solution:

  1. Wait a few seconds and click "Refresh"
  2. Check App settings on GitHub - make sure needed repositories are selected
  3. Try signing out and back in to diffray

Need to change repository access?​

  1. Go to GitHub in Installed Apps settings
  2. Change the repository list
  3. Refresh the page in diffray

Next step: Add Repositories to diffray →