Release Note
Generate and update release notes following the standardized format for this repository.
Workflow
Step 1: Gather Information
- Read
references/format-standard.mdto understand the release note format - Get current version from
pyproject.tomlusing:grep "^version" pyproject.toml - Get the last release tag:
git tag -l | tail -1(if no tags, this is the initial release) - Get commit history since last tag:
- If tag exists:
git log <last-tag>..HEAD --oneline - If no tag:
git log --oneline
- If tag exists:
Step 2: Analyze Changes
- Review each commit message to identify changes
- Map changes to the format:
{plugin_name}@{category}@{feature_name} - Categorize each change as: Add, Update, Fix, or Remove
- Cross-reference with
plugins/directory structure to verify accuracy
Step 3: Handle Conflicts
If information from user conflicts with what you read:
- Ask user to confirm the correct information
- User input takes precedence after confirmation
Step 4: Update release-history.rst
- Read current
release-history.rst - Update the version entry with:
- Correct version number from pyproject.toml
- Today's date in YYYY-MM-DD format
- Entries grouped by change type (Add, Update, Fix, Remove)
- Alphabetical order within each group
- Omit empty change type sections
Entry Format
- {plugin_name}@{category}@{feature_name}: {brief description}
Valid Categories
skills- Agent skillsslash-commands- Slash commandsagents- Custom subagentshooks- Automation hooks
Change Types
- Add - New additions
- Update - Modifications to existing features
- Fix - Bug fixes
- Remove - Deletions
Example Output
0.1.1 (2025-01-13)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Add**
- mini-kanban@skills@mini-kanban: file-based task management
- mini-kanban@slash-commands@mini-kanban: kanban command wrapper
- youtube@skills@youtube-video-to-audio: YouTube to audio converter