api-changelog-versioning

What it does

This skill instructs AI agents to automatically generate structured changelog entries whenever an API version is updated. It ensures that release notes clearly document new features, deprecated endpoints, and breaking changes for developers.

When to use it

• You need to maintain a consistent history of API modifications across multiple releases.
• Your team requires clear documentation of breaking changes before deploying updates.
• You want to automate the creation of CHANGELOG.md or similar release notes files.
• You are managing public APIs where users rely on version-specific stability guarantees.

Key capabilities

• Generates timestamped entries for specific API versions.
• Categorizes changes into features, bug fixes, and deprecations.
• Highlights breaking changes that require user action.
• Formats output in standard markdown or JSON structures.

Example prompts

• "Generate a changelog entry for API version 2.1, adding the new /users endpoint and deprecating /v1/auth."
• "Create a release note summary for the latest update, focusing on breaking changes that affect existing integrations."
• "Draft a structured changelog for this week's API updates, including performance improvements and security patches."

Tips & gotchas

Ensure your AI agent has access to the specific details of the changes made in the current release cycle. Without accurate input about what was modified, the generated changelog may lack critical information or miss breaking changes entirely.