Skip to content

feat(catalog): add API Evolve (api-evolve) community extension#2479

Merged
mnriem merged 3 commits into
github:mainfrom
Quratulain-bilal:feat/catalog-add-api-evolve
May 7, 2026
Merged

feat(catalog): add API Evolve (api-evolve) community extension#2479
mnriem merged 3 commits into
github:mainfrom
Quratulain-bilal:feat/catalog-add-api-evolve

Conversation

@Quratulain-bilal
Copy link
Copy Markdown
Contributor

Extension Submission

Extension Name: API Evolve
Extension ID: api-evolve
Version: 1.0.0
Author: Quratulain-bilal
Repository: https://github.com/Quratulain-bilal/spec-kit-api-evolve
Release: https://github.com/Quratulain-bilal/spec-kit-api-evolve/releases/tag/v1.0.0

Description

Managed API contract evolution for Spec-Driven Development. Detects breaking changes before they ship, enforces SemVer, orchestrates deprecations, and gates /speckit.implement until contract policy is satisfied. Works across OpenAPI 3.x / Swagger 2.0, GraphQL SDL, gRPC .proto, and JSON Schema.

Why this fills a gap

Spec Kit ships strong workflow scaffolding around specify → plan → tasks → implement, but contract drift between a spec and the API the spec is supposed to govern is unmanaged today. API Evolve plugs into all five lifecycle hooks to close that gap:

  • after_specify → detect contract files, annotate spec with current surface
  • after_plan → freeze immutable baseline before implementation
  • after_tasks → inject [API-*] governance tasks (diff, classify, deprecate, bump)
  • before_implementthe gate: refuses to dispatch on undeclared breaking changes, missing version bumps, or unmet deprecation policy
  • after_implement → generate consumer-facing changelog and client-impact report

Capabilities

  • 12 commands: orchestrate, detect, baseline, diff, classify, bump, deprecate, deprecation-status, gate, changelog, client-impact, release
  • 5 lifecycle hooks (gated before_implement)
  • Per-feature policy via api-evolve/policy.yml
  • Known-consumer mapping so breaking changes show which client breaks
  • Multi-format with content-sniffing detection

Checklist

  • Valid extension.yml manifest
  • README.md with installation and usage docs
  • LICENSE file (MIT)
  • CHANGELOG.md present
  • GitHub release created (v1.0.0)
  • Added to extensions/catalog.community.json between agent-assign and architect-preview
  • Added to Community Extensions table in README.md
  • Top-level updated_at bumped
  • All commands and hooks documented

Notes for reviewers

  • Listed under category process and Read+Write because the gate orchestrates state across phases and the release command updates contract version fields and CHANGELOG.md.
  • Contract files themselves are never auto-edited — only versions and changelogs are written by the extension.
  • The before_implement gate can be relaxed per-feature via policy if maintainers sign off.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds the new “API Evolve” community extension to Spec Kit’s community extension catalog and the README’s Community Extensions table, making it discoverable via the repo and downstream catalog consumers.

Changes:

  • Added “API Evolve (api-evolve)” to the Community Extensions table in README.md (kept in correct alphabetical position by display name).
  • Added a new api-evolve entry to extensions/catalog.community.json (kept in correct alphabetical position by extension id) and bumped the catalog’s top-level updated_at.
Show a summary per file
File Description
README.md Adds the API Evolve row to the Community Extensions table.
extensions/catalog.community.json Registers the api-evolve extension metadata and updates updated_at.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

…evolve

# Conflicts:
#	extensions/catalog.community.json
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new

@mnriem mnriem requested a review from Copilot May 7, 2026 19:40
@mnriem mnriem merged commit abb5fe7 into github:main May 7, 2026
16 checks passed
@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented May 7, 2026

Thank you!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 2/2 changed files
  • Comments generated: 0 new

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants