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
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
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
Technical Scope