ENGINEERING
README example drift to auto-filed GitLab issue
Weekly, validates every code sample embedded in your README against the latest API and opens (or updates) a single GitLab issue listing each broken snippet with its file, line…
How it runs
The automated pipeline, trigger to output.
- TriggerWeekly schedule fires
- ActionInstall latest package, extract README code blocksShell
- ActionRun each snippet, record pass/fail with outputShell
- LogicAny failures? End quietly if all pass
- ActionSearch GitLab for existing open drift issueGitLab
- OutputCreate or update GitLab issue with broken examplesGitLab
What it does
This workflow turns documentation drift into actionable engineering work. On a weekly cadence it runs each fenced code block from your README against the current API surface, then files the results as a GitLab issue assigned to the docs owner. If an issue from a prior run is still open, it updates that issue instead of creating a duplicate, so the backlog stays clean.
When to use it
Use it when broken README examples should become tracked, assignable work rather than an ephemeral chat ping. Best for teams that triage documentation defects through their issue tracker and want a durable record.
How it works
- 1A weekly schedule triggers the run.
- 2A shell step installs the latest package version and extracts runnable code blocks from the README.
- 3A shell step executes each snippet and records pass or fail with captured output.
- 4A logic step checks whether any snippet failed; if all pass, the run ends quietly.
- 5A GitLab step searches for an existing open drift issue by a stable title marker.
- 6An output step creates a new issue or edits the existing one with the current list of broken examples.
Set it up
What you configure once, before turning it on.
- 1Connect ShellRun sandboxed commands inside the workspace.
- 2Connect GitLabRepos, MRs, pipelines, registry.
- 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
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…
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.
Scan for deprecated endpoints and email consumers a weekly sunset countdown
On a weekly schedule, scans the OpenAPI spec for endpoints marked deprecated with a sunset date, and emails each consuming team a countdown of how many days remain before removal.
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.
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.
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.