DOCUMENT OPS

Block PRs whose README code examples no longer compile

On every pull request that touches a README, extracts the fenced code blocks, compiles and runs them in a sandbox.

CategoryDocument Ops
Enginesim
Difficultyintermediate
Triggerwebhook
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerPull request opened or synchronizedGitHubGitHub
  • LogicOnly continue if a Markdown file changed
  • ActionExtract fenced code blocks from changed READMEsGitHubGitHub
  • ActionCompile and run each block in a sandboxShell
  • LogicAggregate results into pass or fail
  • OutputPost blocking GitHub check on the PRGitHubGitHub

What it does

Turns your README code samples into a merge gate. When a pull request changes any Markdown doc, this workflow pulls every fenced code block, runs it in an isolated shell, and reports a single GitHub status check. A broken example fails the check, so drift never reaches the default branch.

When to use it

Use it on any public-facing library or SDK where the README is the first thing users copy-paste. If "the quickstart doesn't even run" would be an embarrassing issue to receive, gate it here.

How it works

  1. 1A pull request is opened or updated on GitHub.
  2. 2A filter checks whether any `*.md` file changed; if not, the run exits clean.
  3. 3The workflow fetches the changed Markdown and extracts every fenced code block tagged with a runnable language.
  4. 4Each block is written to a temp file and executed in a sandboxed shell with the repo's install step first.
  5. 5Results are aggregated into one pass/fail summary and posted back as a GitHub commit status check that blocks merge on failure.

Set it up

What you configure once, before turning it on.

  1. 1
    Connect GitHubRepos, issues, pull requests, actions.
  2. 2
    Connect ShellRun sandboxed commands inside the workspace.
  3. 3
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  4. 4
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  5. 5
    Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.

Run this workflow in your colony.

14-day trial. No DevOps. No Sales call. Provisioned in under a minute.