e-volv

Review playbook

OpenAPIDriftCheck

Regenerates the OpenAPI spec from decorators on controller/DTO PRs and classifies every diff as additive, breaking, or docs-only.

On a pull request that touches controllers, DTOs, or the OpenAPI spec, regenerate the OpenAPI document from code decorators, diff it against the committed spec, classify every change as additive, breaking, or documentation-only, and post inline review threads on breaking changes. A summary report is published as a single pull-request comment.

Identifier
openapi-drift-check
Version
1.0.0
Steps
4
Triggers
2
  • openapi
  • api
  • contract
  • drift
  • breaking-changes
  • documentation

When it runs

Pull requestpull_request.opened
Settle delay
30s after the event

Only when all hold

  • pullRequest.isDraft not equals true
  • actor.username not in dependabot, dependabot[bot], renovate, renovate[bot], github-actions, github-actions[bot]
  • actor.username not contains [bot]
Pull requestpull_request.synchronize
Settle delay
60s after the event

Only when all hold

  • pullRequest.isDraft not equals true
  • actor.username not in dependabot, dependabot[bot], renovate, renovate[bot], github-actions, github-actions[bot]
  • 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.

React Flow
  1. 01
    PR Opened / Updatedtrigger

    The event that starts the run.

  2. 02
    Clone Repositorygit.clone

    Shallow-clones the repository at the right ref.

  3. 03
    Check OpenAPI Driftagent.run

    One agent works the task with its toolkit.

  4. 04
    Publish Drift Reportreport.publish

    Posts or updates a deduplicated report comment.

The agent

OpenAPI Drift Checker

Base type
Senior Developer
Temperature
0.2
Max iterations
30
Tools
7

Git provider · 2

  • get_pull_request_diffGet Pull Request Diff · read
  • add_pull_request_review_threadAdd PR Review Thread · write

Filesystem · 2

  • read_fileRead File · read
  • list_dirList Directory · read

Terminal · 1

  • run_terminal_cmdRun Terminal Command · write

Code search · 1

  • code_searchCode Search · read

Status · 1

  • update_statusUpdate Status · write