Skip to main content

About GitHub Integration

The GitHub Integration connects your GitHub repositories to Sawmills Telemetry Reviewer. After the integration is enabled, Sawmills can use the installed GitHub App to access the repositories you selected for instrumentation review workflows. See Instrumentation Reviewer.

Step-by-Step: Configure GitHub Integration

1. Access Integrations

Open the user menu at the top right and select Integrations.

2. Connect GitHub App

In the Integrations section, click Connect GitHub App.

3. Install the GitHub App

GitHub will open the installation flow. Choose the GitHub organization or account you want to connect, then select the repositories that should be available to Sawmills Telemetry Reviewer.

4. Return to Sawmills

After the GitHub App installation is complete, GitHub redirects you back to the Sawmills integrations page.

5. Verify the Integration

Confirm that the GitHub integration appears as connected. If needed, you can reconnect the app later to change the selected repositories.

What the Integration Is Used For

The GitHub integration is used by Sawmills Telemetry Reviewer to access repository code for instrumentation review workflows. The integration stores the GitHub App installation and uses short-lived installation tokens when reviewer workflows need repository access.

Requested GitHub App Permissions

Sawmills Telemetry Reviewer currently requests these GitHub App permissions:
  • Contents: Read
  • Pull requests: Write
  • Issues: Write
  • Checks: Read
  • Statuses: Read
These permissions are defined in the GitHub App manifest used by the integration.

Why These Permissions Are Needed

These permissions let Telemetry Reviewer read pull request changes and repository context, publish review results back to GitHub, and support workflow actions such as comment-driven follow-up and check-run reruns.