Installing the GitHub App
The UXSense GitHub App does two jobs — it's worth knowing both before you install:
- Automatic releases. When you publish a release or push a tagged deploy, UXSense records it and starts the impact-report clock. No manual release entry.
- Drift checks on pull requests. Every PR gets scored against your behavioral load map, and the verdict posts to the PR's checks — plus a comment when something warrants attention.
Install
Go to Connections → GitHub → Install, pick your organization, and grant access to the repositories you deploy from. You can scope it to specific repos — UXSense only needs the ones whose deploys you want analyzed.
Permissions, and why
- Checks (write) — to post Drift verdicts in the merge box.
- Pull requests (write) — to leave the single sticky Drift comment (one comment, edited in place — never a thread of bot spam).
- Contents (read) — to resolve release tags to commits and read changed-file lists.
- Deployments (read) — to find preview deployments for path replay.
UXSense never pushes code, never opens PRs, and never reads repositories beyond what these permissions describe.
What a check looks like
Within a minute of opening or updating a PR you'll see a UXSense behavioral drift check. Clean PRs pass quietly. When a PR touches something your users depend on, the check explains exactly which element, how much load it carries, and which goal path it sits in. See How Drift verdicts work.
Blocking merges (optional)
The check is informational by default. If you want BLOCK verdicts to gate merges, add the UXSense check to your branch protection rules in GitHub — that choice stays in your hands.
← All help articles