Weekly OpenAPI drift check via OpenHands Cloud

[enyst]

This adds a scheduled workflow that runs weekly and uses OpenHands Cloud API to:

• Configure LLM settings (LLM_MODEL, LLM_API_KEY, LLM_BASE_URL)
• Start an OpenHands Cloud conversation against this repo
• Run scripts/update_openapi.py (with a robust fallback) to compare the FastAPI-derived OpenAPI schema vs docs/openapi.json
• If consumer-impacting changes are detected, the agent is instructed to open a Draft PR and follow the repo PR template. The personalized description starts with: "openhands agent:".
• Always emits a delimited report block in workflow logs that’s uploaded as an artifact

Secrets required:

• OPENHANDS_CLOUD_API_KEY (required)
• LLM_API_KEY (required)
• LLM_MODEL (optional)
• LLM_BASE_URL (optional)
• CLOUD_API_URL (optional, defaults to https://app.all-hands.dev)

You can test via workflow_dispatch.

Co-authored-by: OpenHands-GPT-5 openhands@all-hands.dev

Summary by CodeRabbit

• New Features

  • Adds automated weekly OpenAPI drift detection and reporting, producing a human-readable summary and artifacts.
  • Supports manual runs on demand.
  • When drift is found, can propose a small changelist with a draft PR to align specs.

• Chores

  • Enhances CI with robust validation of required secrets, safer error handling, and clearer logs for auditability.

[gemini-code-assist]

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new GitHub Actions workflow to run a weekly OpenAPI drift detection using OpenHands Cloud. It configures LLM settings, starts a cloud conversation to run checks or fallback generation, polls for completion, extracts a delimited report, parses drift/PR info, uploads artifacts, and exposes outputs.

Changes

Cohort / File(s)	Change Summary
CI: OpenAPI drift workflow .github/workflows/weekly-openapi-drift.yml	Introduces a scheduled/manual workflow that configures OpenHands Cloud, runs drift analysis via scripted conversation, polls for completion, extracts delimited report, parses drift/PR details, uploads artifacts, and sets outputs. Includes secret validation, optional LLM settings, and error handling.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor GH as GitHub Actions
  participant OH as OpenHands Cloud API
  participant Repo as Repo Scripts

  GH->>GH: Validate required secrets
  GH->>OH: POST /api/settings (LLM config, optional fields)
  GH->>OH: POST /api/conversations (start drift session with prompt)
  loop Poll until complete (timeout ~120m)
    GH->>OH: GET /api/conversations/{id}
    OH-->>GH: status (running|completed|error)
  end
  GH->>OH: GET /api/conversations/{id}/events
  OH-->>GH: events with messages
  GH->>GH: Extract report between markers
  GH->>GH: Parse drift status, PR URL/number
  GH->>Repo: Upload artifacts (report, events)
  GH->>GH: Set workflow outputs and summary

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

I twitch my nose at Saturday’s dawn,
Scripts hop forth, the drift is drawn.
Clouds confer, reports appear—
Marks between lines make truth clear.
If specs lag behind the herd,
I branch, I patch—swift as a word.
Thump-thump: CI’s chorus heard. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0ec6ed2 and be9368a.

📒 Files selected for processing (1)

• .github/workflows/weekly-openapi-drift.yml (1 hunks)

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/weekly-openapi-drift-cloud-action

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.