ENGINEERING
Validate and sync README examples on package release
When a new package version publishes, re-runs every documented code example against it and, if all pass, pushes the verified README content to your ReadMe.com developer hub.
How it runs
The automated pipeline, trigger to output.
- TriggerPackage release webhook with new versionHTTP webhook
- ActionInstall released version, extract README code blocksShell
- ActionRun all snippets and aggregate resultsShell
- LogicAll examples pass? Branch on result
- ActionPush validated README to ReadMe.com docs pageReadMe
- OutputAlert release channel on any failureSlack
What it does
This workflow gates your public docs on a clean example run at release time. The moment a new version is published, it executes every fenced code block in the README against that exact version. Only when all examples pass does it publish the README to your ReadMe.com hosted documentation, guaranteeing the developer hub never ships a broken sample for a live release.
When to use it
Use it when your hosted docs must stay in lockstep with each published release and you want a hard gate preventing broken examples from reaching developers. Ideal for teams that maintain a ReadMe.com hub fed from a repo README.
How it works
- 1A release webhook from your registry triggers with the new version tag.
- 2A shell step installs that exact published version and extracts runnable code blocks.
- 3A shell step runs every snippet and aggregates results.
- 4A logic step branches on whether all examples passed.
- 5On full pass, a ReadMe step pushes the validated README content to the matching docs page.
- 6On any failure, a Slack message alerts the release channel and the sync is skipped.
Set it up
What you configure once, before turning it on.
- 1Connect HTTP webhookTrigger any URL on agent actions.
- 2Connect ShellRun sandboxed commands inside the workspace.
- 3Connect ReadMeAPI docs, changelog, auth.
- 4Connect SlackChannels, DMs, threads, mentions.
- 5Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 6Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 7Test, then turn it onRun once against a sample, confirm the output, then enable the trigger.
More Engineering workflows
Gate breaking API PRs behind downstream consumer acknowledgement
When a PR introduces a breaking contract change, comments the impact summary back on the PR, applies a blocking label.
Publish a versioned API changelog to Confluence on each release tag
On a new semver release tag, gathers the contract changes since the last release and writes a clean.
Agent reviews model-license fit and suggests compliant swaps on the PR
When a PR adds a Hugging Face model, an agent reads the model card and license, judges fit against your commercial-use policy.
Upgrade Impact Router to Module Code Owners
Maps a dependency-bump PR's affected modules to their CODEOWNERS, then DMs each owner on Slack with only the changelog slice that touches code they own.
Re-Voice IVR Prompts on Phone-Tree Config Merge
When a phone-tree config change merges in GitHub, regenerates the ElevenLabs audio for any prompt whose script changed in the diff and opens a follow-up PR adding the new audio…
Upstream Release to Notion Upgrade Brief
When a watched package publishes a new release, fetches the release notes, maps them to the internal modules that depend on it.
Run it inside a business
This workflow drops into a full company template. Import the org, and this is one of the playbooks its agents run.
Run this workflow in your colony.
14-day trial. No DevOps. No Sales call. Provisioned in under a minute.