Skip to main content
Connecting GitHub lets Traversal correlate incidents with recent code changes by pulling commits and pull requests, helping it explain “what changed” alongside telemetry evidence.

​
What Traversal reads

  • Pull requests — recent PRs, diffs, and review comments
  • Commits — commit history and changed files
  • Code — file contents and code search results

​
Repository access during investigations

Traversal can combine GitHub API data with a temporary checkout of an allowed repository. API access provides pull request metadata, diffs, and individual file contents. A checkout lets the investigation inspect the wider codebase with local search and analysis tools when it needs more context. Traversal can clone repositories and inspect remote references using safe, read-only Git operations. It can also use a guarded set of read-only GitHub operations for pull requests, issues, workflows, releases, and other repository context. The repositories and organization available to an investigation remain limited by the GitHub integration’s configuration and credentials. Repository checkouts run in an ephemeral agent sandbox. Traversal isolates Git configuration for credentialed operations, provides credentials only for the sandbox operation, and redacts credential values from command output. For example, you can ask Traversal to:
  • “Compare the failing stack trace with the implementation in myorg/service-api.”
  • “Inspect the repository for code paths that could explain the latency increase.”
  • “Check whether a recent pull request changed retry behavior in the affected service.”
Private or self-hosted GitHub endpoints require a Traversal Connector that can reach the endpoint. GitHub Enterprise repository access supports instances at the hostname root, such as https://github.yourcompany.com, with the standard API at /api/v3. Instances mounted under an additional URL path prefix, such as https://github.yourcompany.com/github/, are not compatible with repository checkout.

​
Setup

1

Install the app

In Traversal, go to Company Knowledge > Integrations, select GitHub, and click Install GitHub App. You’ll be redirected to GitHub to authorize the Traversal app.
2

Select repositories

Choose the GitHub organization and repositories you want Traversal to access. After authorization, you’ll be redirected back to Traversal with the Installation ID populated automatically.
3

Use an existing installation ID (optional)

If the Traversal GitHub App is already installed, you can paste the existing Installation ID instead of running the install flow again.
4

Save

Click Save.

​
Required permissions (read-only)

Repositories: Commit statuses, Contents, Custom properties, Dependabot alerts, Deployments, Issues, Metadata, Pull RequestsOrganization: Events, Knowledge bases, Issue Types, Members

​
Optional scoping

You can optionally narrow GitHub access in Traversal:
  • Use Repositories for a list of repositories in owner/repo format
  • Use Organization for organization-wide access

​
Private network access

If the service endpoint is not directly reachable by Traversal (as is common with self-hosted services), deploy a Traversal Connector in a network that can reach it. When configuring the integration, select that connector under Network Access Needed. The service endpoint does not need public internet exposure. See Set up the Traversal Connector for deployment and network requirements.

​
More information