Skip to content

Replace spec-drift issues with an auto-merging weekly regeneration PR - #101

Open
splch wants to merge 3 commits into
mainfrom
consolidate-spec-drift
Open

Replace spec-drift issues with an auto-merging weekly regeneration PR#101
splch wants to merge 3 commits into
mainfrom
consolidate-spec-drift

Conversation

@splch

@splch splch commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Replace spec-drift.yml (weekly issue) with spec-sync.yml: on drift it re-vendors openapi.json, regenerates the client, opens a spec-drift-labeled PR carrying the spec diff, and squash-merges once all required checks pass.
  • Drift gate unchanged (del(.info.description), Fix spec-drift false positives from date-only description changes #49); regeneration matches generated.yml, so the required staleness check verifies every sync PR.
  • Auth is the org octo-sts self-modify pattern (trust policy in .github/chainguard/, no stored secrets); the merge relies on the octo-sts App's PR-only bypass of the main ruleset (one-time settings change, applied separately).

First run after merge picks up the drift tracked in #89.

Test plan

  • uvx zizmor and uvx pre-commit run pass locally with no new findings.
  • After merge: gh workflow run spec-sync.yml, confirm the sync PR opens with the diff and self-merges once checks pass.

Important

Most code in ionq_core/ is auto-generated and overwritten on regeneration.
See CONTRIBUTING.md for which files are safe to edit.

@splch
splch requested a review from a team as a code owner September 1, 2026 17:28
@splch splch added the spec-drift Upstream OpenAPI spec has changed label Sep 1, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Replaces issue-based spec drift reporting with automated client regeneration and merging.

Changes:

  • Adds weekly spec synchronization and regeneration.
  • Adds octo-sts authentication policy.
  • Updates documentation and removes the previous drift workflow.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
.github/workflows/spec-sync.yml Creates, validates, and merges regeneration PRs.
.github/workflows/spec-drift.yml Removes issue-based drift reporting.
.github/chainguard/spec-sync.sts.yaml Grants scoped automation permissions.
CONTRIBUTING.md Documents automated synchronization.
AGENTS.md Updates workflow guidance.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/spec-sync.yml
Comment thread .github/workflows/spec-sync.yml Outdated
@antalszava
antalszava self-requested a review September 2, 2026 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

spec-drift Upstream OpenAPI spec has changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants