Api changelog versioning
Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API consumers. Use when managing API versions, communicating breaking changes, or creating upgrade guides.From its SKILL.md
npx -y skills add VRIL-LABS/skill-jam --skill api-changelog-versioningAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.9 KB, 441 tokens by cl100k_base, as published. Nobody here has run it
API Changelog & Versioning
Document API changes with clear migration paths and deprecation timelines.
Changelog Structure
# API Changelog
## v3.0.0 (2025-01-15) - Breaking Changes
### Breaking Changes
- Response format now follows JSON:API specification
- Authentication switched from API tokens to JWT Bearer
### Migration Steps
1. Update base URL to `/api/v3`
2. Replace `Authorization: Token xxx` with `Authorization: Bearer xxx`
3. Update response parsing for new envelope format
## v2.5.0 (2024-12-01) - Features
### New Features
- Webhook support for order events
- Batch operations endpoint
- Field filtering via `?fields=` parameter
### Improvements
- 56% faster response times on /products
- Enhanced error messages with field-specific suggestions
Deprecation Schedule
| Version | Status | Support Until |
|---|---|---|
| v3.x | Current | Full support |
| v2.x | Maintenance | 2025-06-01 |
| v1.x | EOL | Unsupported |
Version Support Policy
- Current: Full support, new features
- Maintenance: Bug fixes and security only
- EOL: No support, remove from docs
Migration Guide Template
## Migrating from v2 to v3
### Before (v2)
```json
{ "user_name": "john" }
After (v3)
{ "data": { "type": "user", "attributes": { "name": "john" } } }
Steps
- Update SDK to v3.x
- Modify response handlers
- Test in staging environment
- Update production
## Best Practices
- Provide 3-6 months deprecation notice
- Include before/after code examples
- Mark breaking changes prominently
- Maintain backward compatibility when feasible
- Version via URL path (`/api/v1/`) for clarity
What ships with it
Read from the repository
Just SKILL.md. No reference files, no scripts.
Gives 1 of the 12 instructions most readme changelog skills give in 441 tokens
Counted across 446 of the 460 authors here whose files we hold, read 2026-09-06
- Follow Keep a Changelog formatin 24 of 446
- Collect commits since the last git tagin 15 of 446, across 13 files
- Omit empty sectionsin 14 of 446
- Put breaking changes first with migration stepsin 14 of 446
- Include migration guidance for breaking changesin 11 of 446, across 10 files
- Categorize commits by conventional commit prefixin 11 of 446
- Mark breaking changes prominentlyhere, and in 10 of 446
- Prepend the new entry to CHANGELOG.mdin 9 of 446
- Highlight breaking changes with migration notesin 8 of 446, across 7 files
- Classify changes into Keep a Changelog categoriesin 8 of 446, across 7 files
- Group related commits into single entriesin 8 of 446
- Write the changelog from commitsin 8 of 446
Said here and by no other author read
- Document API changes with clear migration paths
- Provide 3-6 months deprecation notice
- Maintain backward compatibility when feasible
- Version via URL path for clarity
- Publish a deprecation schedule with support dates
- Remove EOL versions from docs
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.