ENGINEERING
Block merge requests that break documented examples
On every GitLab merge request, runs the README code examples against the branch's code and posts a pass/fail comment plus a commit status.
How it runs
The automated pipeline, trigger to output.
- TriggerGitLab merge request opened or updatedGitLab
- ActionCheck out branch and build locallyShell
- ActionExtract and run README code blocks against branchShell
- LogicTally failures, compose markdown summary table
- ActionPost results comment on the merge requestGitLab
- OutputSet commit status to reflect example healthGitLab
What it does
This workflow makes documentation correctness part of code review. When a merge request opens or updates, it builds the branch, runs every README code example against the proposed changes, and posts the results back as an MR comment with a green or red commit status. Reviewers no longer discover a broken example after merge.
When to use it
Use it when API changes frequently invalidate README snippets and you want that caught at review time rather than nightly. Best for teams already gating merges on GitLab commit statuses who want docs treated as first-class.
How it works
- 1A GitLab merge request event triggers the run with the source branch.
- 2A shell step checks out the branch and builds it locally.
- 3A shell step extracts and executes each README code block against the branch build.
- 4A logic step tallies failures and composes a markdown summary table.
- 5A GitLab step posts the summary as a comment on the merge request.
- 6An output step sets a pending, success, or failed commit status so the merge gate reflects example health.
Set it up
What you configure once, before turning it on.
- 1Connect GitLabRepos, MRs, pipelines, registry.
- 2Connect ShellRun sandboxed commands inside the workspace.
- 3Set each agent's modelWe leave models unset so you pick the tier — fast + cheap, or top-quality.
- 4Tune it to your dataEdit the prompts, filters, and field mappings so it matches how your team works.
- 5Test, 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.