- Home
- Skills
- Basedhardware
- Omi
- Changelog
changelog_skill
7.6k
GitHub Stars
1
Bundled Files
2 months ago
Catalog Refreshed
4 months ago
First Indexed
Readme & install
Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.
Installation
Preview and clipboard use veilstrat where the catalogue uses aiagentskills.
npx veilstrat add skill basedhardware/omi --skill changelog- SKILL.md2.7 KB
Overview
This skill generates and updates changelog entries from git commits and merged pull requests. It parses commit messages, groups changes into conventional categories, formats a release entry, and appends it to CHANGELOG.md with version and date. The output is ready-to-publish release notes that highlight features, fixes, and breaking changes.
How this skill works
The skill fetches commits since the last tag or release and parses messages following the conventional commits format. It extracts type, scope, description, issue references, and any breaking-change notes. Changes are grouped into categories (Added, Changed, Fixed, Breaking Changes, etc.), formatted into a standard markdown changelog entry, and inserted at the top of CHANGELOG.md with version and release date.
When to use it
- When cutting a new release or bumping version
- After merging pull requests into the main branch
- When preparing release notes for stakeholders
- When a user requests an up-to-date changelog
- Before publishing packages to package registries
Best practices
- Follow conventional commits for clear parsing and categorization
- Include issue numbers and concise descriptions in commit subjects
- Add BREAKING CHANGE in body or footer for incompatible changes
- Run the skill after validating tests and CI to ensure accuracy
- Review generated entry before publishing to include any manual notes
Example use cases
- Generate changelog for a patch release after multiple bugfix merges
- Create release notes for a new feature version including contributor credits
- Produce a draft changelog before publishing mobile/Flutter app builds
- Automatically update CHANGELOG.md in CI when a release tag is created
- Consolidate merged PRs into a single formatted entry for release PR
FAQ
It expects conventional commits (type(scope): subject with optional body and footer). Types like feat, fix, docs, refactor, perf, chore are supported.
How does it detect breaking changes?
It scans commit bodies and footers for the text BREAKING CHANGE or equivalent notes and promotes those items to the Breaking Changes section.
Can it include contributor credits and issue links?
Yes. If commit metadata or PR data include author and issue references, the skill includes contributor names and issue numbers in the entry.