Skip to main content

At a glance

  • Preview options: A) predictable URL pattern, B) URL from an existing deploy workflow, C) temporary preview built inside the job. C is not allowed for generation.
  • PR comments come from Checksum, not the workflow: the action passes the PR on pull_request events, and generation posts its own “Checksum Auto-Generate” comment. No comment steps, no pull-requests: write.
  • Permissions: contents: read, pull-requests: read. Skip fork PRs with an if: (no secrets).
  • Cancelling the workflow doesn’t stop a Checksum run.
Developer guide
Pick a preview, fill in the prompts, and paste them into your coding agent

How to use the prompts

1

Fill in the placeholders

Replace every {{PLACEHOLDER}}. If you don’t know a value, write ASK ME or leave the placeholder as it is. The agent always asks about your setup before it writes anything (see “Step 0” in the shared context).
2

Trim the optional blocks

Keep the [OPTIONAL: …] blocks that apply and delete the rest.
3

Leave the fixed requirements alone

The Fixed requirements sections come from these docs and cover what agents most often get wrong.
4

Paste into your agent

Paste the shared context first, then Prompt 1, Prompt 2, or both.

Choose a preview URL

Both workflows point Checksum at the PR’s preview URL. How long that URL has to stay up depends on which workflow uses it:
Generation needs a persistent preview URLFor generation on PR open, the preview has to stay up for at least as long as a generation session. For example, Firebase Hosting preview channels last 7 days by default, and Vercel, Netlify, Cloudflare Pages and Render keep per-PR preview deployments until the PR closes. Temporary URLs, such as a tunnel the job opens or a preview that’s deleted when the workflow ends, won’t work for generation.

Shared context

Paste this before either prompt. It describes your repositories, secrets and preview, and tells the agent to ask before it builds.

Prompt 1: Sharded test run on PR, with auto-healing

Builds a workflow that runs your suite against the PR’s preview as a sharded run, passes or fails the check on the run’s verdict, and heals failures. It uses the GitHub Action by default.

Prompt 2: Test generation when a PR opens

Has the agent pick between Checksum’s built-in auto-generate, a workflow that calls the generation API, or a /checksum generate comment, and build only the one that fits. The default is the API workflow, since it’s the only one that can pass a per-PR preview URL.
i
How it works
What the fixed requirements protect against, and common problems

Why the fixed requirements are there

Troubleshooting

Checksum posts the comments itself, so the PR has to reach it. With the GitHub Action on a pull_request event this is automatic; on other events, set pr-number and repo-name. With the REST API, send autoHeal.repoName + autoHeal.prNumber (test runs) or prNumber + repoName (generation). The repository must be connected in Git Integration.
No tests matched the selection, which counts as a failure. Check that the tests repo has tests on the branch you run against and that your grep pattern matches them.
Prompt 2 tells it to stop instead. If it didn’t, remove the workflow: the preview disappears long before the generation session ends. Set up a persistent preview first (see Choose a preview URL).

CI/CD Integration

The GitHub Action, the CLI, and the REST API.

Generate Tests

The generation API and PR comments.

Auto-Healing

What happens after a failing run.

Coding Agents & MCP

Connect your agent to Checksum.