The Valet GitHub App

How Valet acts on GitHub for your agents, and the limits it works within.

What it is

Valet acts on GitHub as a GitHub App installed on the repositories agents may work in. For each job it asks GitHub for a short-lived installation token narrowed to that job's repositories and its role's permissions. The token stays inside Valet: agents never see it.

Permissions

PermissionLevelUsed for
ContentsRead & writeCloning, and pushing to an agent's own agent/<job>/ branch
Pull requestsRead & writeReading, opening and commenting on pull requests
IssuesRead & writeReading and commenting on issues (triage)
ChecksReadReading CI results
MetadataReadRequired by GitHub

It never asks for Administration, and it is never on a ruleset's bypass list: GitHub's own branch protections still apply to everything it does, so a merge to a protected branch always needs a person's review.

Your data

Valet is self-hosted. It runs on your machine or server, keeps its audit log and secrets there, and talks only to GitHub and the other services you configure. It sends nothing to its authors: no telemetry, no analytics, no accounts.

Setting it up

Follow docs/github-app.md to create and install the App, and docs/github-rulesets.md for the branch protections that back it up.

Support

Questions and problems: github.com/xcwds/valet/issues.