Skip to content

CodeLogic GitHub App

The CodeLogic GitHub App connects your GitHub repositories to CodeLogic so pull request activity can drive Change Requests—impact analysis and comparisons for proposed changes—without relying on manually configured repository webhooks.

Why use the GitHub App

Less setup in GitHub
With the app, GitHub delivers the pull request events CodeLogic needs through the app’s subscription. You do not need to add a separate repository webhook, copy a payload URL, or select individual webhook events for each repo (see Configuring GitHub Webhooks only if you must use that legacy path).

Scoped access
During installation you choose organization or account access and either all repositories or only selected ones. Permissions are explicit and revocable from GitHub’s Settings → Applications (or your org’s Third-party access settings).

Preferred authentication to GitHub
CodeLogic uses installation access tokens issued for the app when the app is installed on a repository. That avoids relying on a long-lived personal access token stored in Change Request configuration for GitHub API access when the app covers the repo. If the app is not installed for a repository, CodeLogic can still fall back to credentials configured in Change Request configuration where your process allows it.

Features that depend on GitHub App auth
Some GitHub APIs (for example Check runs) are intended for GitHub Apps. Using the CodeLogic GitHub App ensures CodeLogic can participate in those flows for your repositories when your deployment uses them.

Operational clarity
One integration—the app—carries both event delivery and API access tied to the installation, which is easier to audit and rotate than ad hoc webhooks and PATs spread across teams.

Relationship to Change Requests

Change Requests still require a repository configuration in CodeLogic (repository URL, branch pattern, comparison workspace, and so on). The GitHub App handles how events and credentials are tied to GitHub; the Change Request configuration tells CodeLogic how to interpret and retain those comparisons.

For a full walkthrough that includes GitHub, see Configure Development Spaces.

PAT documentation and the GitHub App

CodeLogic publishes both this GitHub App guide and the existing steps for configuring GitHub credentials with a PAT. They serve different situations:

  • GitHub App (preferred): For repositories covered by the app installation, do not enter or store a PAT in CodeLogic. Use the app and rely on installation tokens—see Preferred authentication to GitHub above.
  • PAT-based setup: Use the PAT instructions when you are not using the GitHub App, when you rely on repository webhooks alone, or when you must authenticate to GitHub for repositories the app does not cover. Those docs remain the reference for username and PAT configuration.

If you cannot use the GitHub App

Some environments restrict third-party GitHub Apps. In that case you can configure a repository webhook and supply credentials according to your security policy. That path is supported but requires more manual steps in GitHub and in CodeLogic.