> ## Documentation Index
> Fetch the complete documentation index at: https://reshot.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat a Journey, Run, Decision, Rendition, Publication, and Release Book as distinct lifecycle objects.
> Never describe imported or customer-attested material as independently verified evidence without a complete hosted custody chain.

# GitHub App

> Connect a repository so Reshot can post the accessibility Check Run and PR summary.

The Reshot GitHub App connects a repository to a Reshot project. Once it is
installed, every publish tied to a pull request posts the `reshot/visual-review`
Check Run and a text flow × context summary
comment with a dashboard review link. The comment does not contain an image grid.

## Installation

### 1. Open project settings

Navigate to **Settings → Integrations** in your project dashboard. Use this page
for first-time installation or to reconnect GitHub later if access changes.

![GitHub Integration Settings](https://files.reshot.dev/docs/platform-settings-integrations/settings-integrations/2dbcf5dd749a9a67b93c45471dd1f7f8.png)

*The GitHub integration settings page.*

### 2. Install the app

Click **Install Reshot GitHub App** and authorize it for your organization.

### 3. Select repositories

Choose which repositories should be connected. A repository can be linked to one
Reshot project at a time.

## Permissions

| Permission    | Access       | Purpose                                  |
| :------------ | :----------- | :--------------------------------------- |
| Metadata      | Read         | Repository information                   |
| Pull requests | Read & Write | Post the text summary and dashboard link |
| Checks        | Write        | Create and update `reshot/visual-review` |

<Note>
  We do **not** read or store your source code. We only process the visual
  assets you explicitly publish.
</Note>

## What CI has to send

Publish the head commit SHA, branch, and pull-request URL with the run so the
check, comment, review evidence, and audit trail all refer to the same change.
See [PR Checks & Merge Gate](/docs/platform/pr-checks) for the CI steps and the
check state model.

## Blocking the merge

Installing the app alone does not block anything — GitHub decides that. Add
`reshot/visual-review` to your branch protection rules to require approval before
merge. The full procedure, including the free-plan advisory behaviour, is in
[PR Checks & Merge Gate](/docs/platform/pr-checks).

## Related

* [PR Checks & Merge Gate](/docs/platform/pr-checks) — Check Run states and branch rules.
* [Review](/docs/platform/review) — how an attributable Decision is recorded.