Skip to content

Implement API changelog generation from OpenAPI spec diffs #620

Description

@Smartdevs17

Context

API changes lack documentation. Developers manually write changelog entries that are frequently forgotten, inaccurate, or omitted.

Current Limitation/Problem

Changelog is a manually maintained markdown file that falls out of sync with actual API changes. Breaking changes are not always documented.

Expected Outcome

Automated changelog generation: compare OpenAPI specs between releases, categorize changes (breaking, additive, deprecation), and publish changelog to developer portal.

Acceptance Criteria

  • CI step: compare PR branch OpenAPI spec against main branch spec using openapi-diff
  • Breaking change detection: removed endpoints, removed fields, changed types (string->number), added required fields
  • Change categorization: breaking (major version), additive (minor), deprecation (patch)
  • Changelog entry: auto-generated markdown with endpoint path, HTTP method, change description, migration guide link
  • PR comment: GitHub Action bot posts changelog preview on PR
  • Publish: on release, append to developer-portal/docs/changelog/ page
  • Edge case: no OpenAPI changes (skip changelog generation)
  • Edge case: multiple OpenAPI spec files (aggregate all diffs)

Technical Scope

  • scripts/api-changelog.sh - changelog generation script
  • .github/workflows/changelog-check.yml - PR changelog check and comment
  • developer-portal/docs/changelog/ - published changelog pages
  • packages/openapi-diff/ - diff utility wrapper
  • backend/shared/openapi/ - spec validation helper

Metadata

Metadata

Assignees

No one assigned

    Labels

    200-points200 point issueStellar WaveIssues in the Stellar wave programdrips-waveIssues in the Drips Wave programhighHigh complexity issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions