Docs

Turnstone

What Turnstone keeps

Turnstone is an optional, read-only dashboard. It keeps facts about bugs and charts them. Your reports, tests, and evidence stay in GitHub or Gitea.

View as Markdown

On this page
  1. Turnstone is the optional part
  2. What Turnstone keeps
  3. What Turnstone never keeps
  4. If the dashboard shows no bugs
  5. If Turnstone lost everything
  6. What the charts are for
  7. What it costs

Turnstone is the optional part

Testkit has four parts. Your repo holds the tests. The CLI runs them. GitHub or Gitea holds the issues, the checks, and the pull requests. Turnstone is the fourth part, and the other three work without it.

The CLI in Testkit 0.4.1 has no Turnstone command. It does not sign in to Turnstone, it does not ask for a Turnstone key, and it does not upload a run to Turnstone. Turnstone gets its facts from GitHub or Gitea, where your team already works.

Campaigns, bug filing, and CI reports need no Turnstone account. testkit bug file and testkit ci report write to GitHub or Gitea, with a token for that host.

What Turnstone keeps

Turnstone keeps facts about each bug.

FactExample
Issue linkThe URL of the issue in your forge
SeverityHow bad the bug is
AreaThe part of the product it is in
CommitsThe commits linked to the bug, such as the one that introduced it
TimestampsWhen it was introduced, found, and fixed

Facts lists every fact and the place Turnstone reads it from.

What Turnstone never keeps

  • The bug report. The text stays in the issue.
  • The tests. They stay in your repo.
  • The evidence. Run output, logs, and artifacts stay in .testkit/results and in your CI.

Turnstone charts a bug without storing its report. That is deliberate. The parts of a bug report that could embarrass you or leak something are the parts Turnstone does not keep.

If the dashboard shows no bugs

If the dashboard shows no bugs after a sync, check two things.

  1. Check that the issue carries the testkit label.
  2. Check that the project reads the repo that holds the issue.

Sync covers both.

If Turnstone lost everything

You would lose your charts. Your issues, tests, pull requests, and CI history would be where they are now, because Turnstone never held them.

What the charts are for

A list of bugs tells you what broke. The facts Turnstone keeps let you ask where bugs come from, why, and how to have fewer of them.

What it costs

The CLI, the runner, campaigns, and everything they send to GitHub or Gitea are free. Turnstone has a free tier, so you can connect early and build up history.

To see your own repo, sign in and connect it on GitHub or Gitea.

  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.