When a release is published, regenerates the client SDK from the release's OpenAPI document, runs the SDK's own build and tests, and opens a pull request against the SDK repository with the regenerated client, a changelog derived from the spec diff, and migration notes for any breaking changes. The PR is held for human review and is not merged automatically.
- Identifier
sdk-regeneration- Version
- 1.0.0
- Steps
- 3
- Triggers
- 1
- sdk
- openapi
- release
- regeneration
- client
- automated
When it runs
release.published- Settle delay
- 10s after the event
Only when all hold
- release.draft not equals true
- actor.username not contains [bot]
The pipeline
The graph below is the one the workflow opens with in the builder — same steps, same layout, drawn on the same canvas. The run playing through it is a simulation; the branches and conditions are real.
- 01Release Published
triggerThe event that starts the run.
- 02Clone SDK Repository ⚠️ SET YOUR REPO
git.cloneShallow-clones the repository at the right ref.
- 03Regenerate SDK
agent.runOne agent works the task with its toolkit.
The agent
SDK Regenerator
- Base type
- Senior Developer
- Temperature
- 0.2
- Max iterations
- 50
- Tools
- 7
Git provider · 3
create_branchCreate Branch · writecreate_or_update_fileCreate or Update File · writecreate_pull_requestCreate Pull Request · write
Filesystem · 2
read_fileRead File · readedit_fileEdit File · write
Terminal · 1
run_terminal_cmdRun Terminal Command · write
Status · 1
update_statusUpdate Status · write
Related playbooks
Changelog Generator
Classifies each merge to the default branch and adds a changelog entry.
Release Notes
Generates clean, categorized release notes from merged PRs when a release publishes.
Release PR Description
Writes user-facing, categorized release notes into the body of every release/* pull request.