The CircleCI App powers the GitHub App integration between CircleCI and GitHub. It connects your CircleCI and GitHub organizations, with granular control over which repositories CircleCI can access. For a full list of features the GitHub App enables, see the VCS integration overview. The CircleCI App can be used alongside the GitHub OAuth integration.

Installation

The CircleCI App should only be installed from the CircleCI web app, at Organization Settings > VCS Connections. Do not start installation from GitHub.

If your GitHub organization uses IP allowlists, you must add CircleCI's IP address ranges to your allowlist before installing.

Each GitHub organization can be connected via GitHub App to only one CircleCI organization, and vice versa.

If during installation you land on the installation configuration page (e.g. https://github.com/organizations/{ORG_NAME}/settings/installations/1234567) and are not redirected back to CircleCI, your GitHub organization is likely already connected to a different CircleCI organization. What to do if this happens.

Managing your installation

You can view your installation status in CircleCI at Organization Settings > VCS Connections.

Uninstalling will permanently delete all CircleCI pipeline definitions and triggers linked to this installation. This cannot be undone.