Skip to main content
The GitHub integration connects your organization to your GitHub repositories. The Select Test page uses it to list the Lager tests in a repository and to run them on a box. Only owners and admins can open Settings > Integrations.

​
Connect the GitHub App

  1. Go to Settings > Integrations.
  2. In the Connect GitHub card, select Connect GitHub App. Stout opens the installation page of the app on GitHub.
  3. On GitHub, select the account or organization for the app.
  4. Give the app access to the repository that holds your Lager tests.
  5. Complete the installation. GitHub returns you to Settings > Integrations.
The Connection Status card then shows Connected, the GitHub account, and the connection date. The Accessible Repositories card lists each repository that the app can access. It shows the default branch of each repository, and it marks private repositories.

​
If the app is already installed

Already installed? Sync links an installation of the app that already exists on GitHub. Stout links it only when it can identify one installation for your organization. If it cannot, the card shows a message. Sync is available only on a Stout deployment that hosts one organization. On a deployment that hosts more than one organization, the card shows a message, and the installation is not linked. Use Connect GitHub App instead. If GitHub reports that the app is already installed, uninstall it in the settings of your GitHub account or organization, then connect again. Stout never links an installation on its own. The Connection Status card only shows the installation that you connected.

​
Set up Repo Tests

The Repo Tests card tells Workbench which repository holds your Lager tests. The card is available after you connect the app.
  1. In Repository, select the repository. If the list is empty, type the name in owner/repo form.
  2. In Tests path, type the directory that holds the tests. The default is tests/lager.
  3. Select Save.
Stout searches the tests path and its subdirectories for .py files. An organization has one Repo Tests setup.

​
Disconnect

On the Connection Status card, select Disconnect. Stout deletes its record of the installation immediately. It does not ask you to confirm. The card then shows Connect GitHub. If Stout cannot disconnect, the card shows the reason. The app stays installed on GitHub. To remove the app, uninstall it in the settings of your GitHub account or organization. After a disconnect, Select Test cannot list or run tests. An owner or admin must connect the app again.

​
Troubleshooting

Select Test

Run a test from the connected repository on a box.

Roles and permissions

See which roles can change integrations.