changelog-gen
Install
mayros skill install changelog-gen
mayros skill install [email protected]
Conventional commit parsing, semver bump suggestion, Keep a Changelog format
README
@apilium/changelog-gen
Generate CHANGELOG.md from conventional commits with breaking change detection and version bump suggestions.
Installation
mayros skill install @apilium/changelog-gen
Prerequisites
gitmust be available on PATH.- The repository should follow Conventional Commits format.
Usage
Generate Changelog
Ask Mayros to generate a changelog from your commit history:
Generate a changelog for the commits since the last tag.
The skill parses conventional commit subjects using the format <type>[optional scope][!]: <description> and groups them into sections (Features, Bug Fixes, Documentation, etc.).
Detect Breaking Changes
Breaking changes are detected from:
- The
!marker after type/scope:feat(api)!: remove endpoint - The
BREAKING CHANGE:footer in the commit body
Version Bump Suggestions
Based on Semantic Versioning:
- Any breaking change --> major bump
- Any
featcommit --> minor bump - Only fixes, docs, refactors, etc. --> patch bump
Output Format
The output follows Keep a Changelog format with grouped sections, abbreviated commit hashes, and comparison links.
Semantic Predicates
| Predicate | Description |
|-----------|-------------|
| changelog:generated | Asserted after producing a changelog |
| changelog:breaking_change | Asserted for each breaking change detected |
| changelog:history | Query for previous changelog generations |
License
MIT
Versions
Comments
Sign in to leave a comment.
Loading comments...