DOCUMENT OPS

Re-run README examples on dependency-bump PRs and report to Discord

When a dependency-update PR is opened, re-runs the README install and import examples against the bumped versions and posts the result both as a PR comment and to a Discord…

CategoryDocument Ops
Enginesim
Difficultyintermediate
Triggerwebhook
Steps6
Setup~15 min

How it runs

The automated pipeline, trigger to output.

  • TriggerPull request openedGitHubGitHub
  • LogicOnly continue for dependency-update PRs
  • ActionInstall bumped deps and run README examplesShell
  • LogicPass or fail from the run
  • ActionComment the verdict on the PRGitHubGitHub
  • OutputPost the result to DiscordDiscordDiscord

What it does

Catches the most common silent drift: a dependency bump that breaks the documented install or import. When a bot opens a dependency-update PR, this workflow checks out that branch, runs the README's install and import examples against the new versions, and reports pass or fail to both the PR and a Discord channel.

When to use it

Use it if you rely on Dependabot or Renovate and have been burned by upgrades that changed an import path, renamed an export, or dropped a documented flag. It makes "does the README still work after this bump" an automatic answer.

How it works

  1. 1A pull request is opened on GitHub.
  2. 2A filter keeps only PRs from your dependency-update bot or branch prefix.
  3. 3The workflow checks out the PR branch and installs against the bumped lockfile in a sandbox.
  4. 4It extracts and runs the README's install and import example blocks in the sandboxed shell.
  5. 5A branch determines pass or fail from the run.
  6. 6It posts a status comment on the PR and a matching message to Discord with the verdict and any error output.

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
    Connect DiscordCommunity channels + voice + bots.
  4. 4
    Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
  5. 5
    Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
  6. 6
    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.