Skip to main content
Stout’s GitHub integration covers two use cases: PR Reviewer (run a fixed set of tests against every PR) and workflow YAML export (commit Stout workflow definitions into a repo so they run inline with your normal CI).

​
Installing the GitHub App

From Settings → Integrations → GitHub:
  1. Click Connect GitHub. Stout redirects you to GitHub’s app installation page.
  2. Pick which repos the Stout app should have access to. You can grant access to all repos, or only specific ones.
  3. Accept the permissions. Typical scopes include contents, pull requests, and checks — verify the exact set against your installed app’s page in GitHub, since the canonical permission list lives in the GitHub App registration rather than in this repo.
  4. GitHub redirects back to Stout, which stores the installation ID and a short-lived access token that gets refreshed as needed.
You can revoke access any time from GitHub’s Settings → Applications page, or from Stout’s integrations page.

​
PR Reviewer

Coming soon. The PR Reviewer dashboard UI is not yet exposed in the sidebar. The underlying routes and GitHub-check plumbing exist; reach out if you want to pilot this ahead of the UI shipping.
From PR Reviewers → New:
  1. Pick a connected repo.
  2. Pick which boxes the reviewer is allowed to run on.
  3. Optionally configure an approval gate — Stout pauses before running until a designated user approves.
  4. Configure rate limiting so a storm of PR updates doesn’t monopolize your fleet.
Once enabled, every PR to that repo gets a Stout — PR Reviewer check. Clicking through from GitHub drops you into the run view in Stout with full logs and artifacts.

​
Workflow YAML export

A workflow with a githubRepo field can publish itself as a GitHub Actions workflow file. When you save the workflow, Stout:
  1. Generates YAML equivalent to your step graph.
  2. Opens a commit on a branch of your choosing (default stout-workflows) with the file at .github/workflows/<workflow-slug>.yml.
  3. Creates a PR if one doesn’t already exist.
Merged YAML runs like any other Actions workflow but dispatches the actual test execution back to Stout via a short-lived API token.

​
Troubleshooting

  • “Repository not found” when picking a repo — the Stout app doesn’t have access. Go to GitHub → Settings → Applications → Stout and add the repo.
  • Checks aren’t appearing on PRs — verify the installation is still active and that the repo has at least one open PR for a branch whose base is tracked.
  • YAML commit fails — Stout needs contents: write on the repo. If the installation was set up before Stout needed that permission, reconnect to accept the updated scope.