Docs

Turnstone

Connect a GitHub repository

Connect a GitHub repository to a Turnstone project, and see the access that Turnstone asks for.

View as Markdown

On this page
  1. Before you connect
  2. Connect the repository
  3. Access

A Turnstone project reads one repository. Follow this page to connect a repository on GitHub to a new project.

Before you connect

Check these conditions first:

  • You are an owner or an admin of your Turnstone organisation. A member or a viewer cannot create a project.
  • The Turnstone GitHub App is installed on the repository.
  • Your GitHub account can read the repository.

Connect the repository

  1. Open the Turnstone dashboard and sign in.
  2. Select New project.
  3. Enter a project name.
  4. Choose GitHub as the provider.
  5. Enter the repository as owner and name, for example acme/checkout. Do not enter the full URL.
  6. Select Connect repository. GitHub asks you to authorise the Turnstone GitHub App.
  7. Approve the request. GitHub returns you to the dashboard, and you should see the message "Repository connected."

If Turnstone does not connect the repository, check the conditions in Before you connect. Then start again from step 2.

Turnstone syncs the repository when you connect it. Sync describes when Turnstone reads the repository again.

Access

Turnstone uses GitHub access at two points.

When you select Connect repository, GitHub asks you to authorise the App for your account. Turnstone uses that authorisation once. It checks that your GitHub account can read the repository and that the App is installed on it. Turnstone does not store your GitHub token.

After that, Turnstone reads through the App's installation. Turnstone stores the id of the installation. A sync reads the repository's issues, commits, and pull requests.

Turnstone never writes to GitHub. It creates no issue, no comment, no check, and no commit status. The Testkit CLI posts the commit status and the pull request comment from your CI job, with your CI job's token.

To end Turnstone's access, remove the repository from the App's installation in your GitHub settings.

  1. OverviewStartWhat Testkit is, and what you need to run it.
  2. Get startedStartFive steps from install to a merge gate.
  3. Test filesWrite testsWhere a test lives and what its name means.
  4. Contract testsWrite testsCall your running service from Node.
  5. HTTP testsWrite testsDrive routes with k6, signed in as named actors.
  6. Browser testsWrite testsAssert on a real page in Chromium.
  7. Database testsWrite testsRun SQL against a Postgres that Testkit builds.
  8. CIRunOne command decides whether a pull request merges.
  9. ResultsRunWhere a run's evidence lands and how to read it.
  10. CLIRunEvery command and flag.
  11. ConfigurationRunEvery field of testkit.config.ts.
  12. CampaignsHunt bugsGive your agent a target and collect proven bugs.
  13. Bug reportsHunt bugsThe five things every issue states.
  14. TurnstoneTurnstoneWhat the dashboard keeps, and what it never stores.
  15. Connect GitHubTurnstoneConnect a repository, and see the access Turnstone asks for.
  16. Connect GiteaTurnstoneAdd your Gitea host, then connect a repository.
  17. SyncTurnstoneWhen Turnstone reads your issues, and what it reads.
  18. FactsTurnstoneEach fact about a bug, and where Turnstone reads it.