SuperAPI AI Directory

changelog-generator

General & other

View repository

Updated 10-15 21:04

About this skill

Changelog Generator Skill

This skill automatically generates a beautiful Changelog from Git commit history.

Overview

It analyzes Git commit messages and generates an organized Changelog in Conventional Commits format or Keep a Changelog format.

Key Features

  • Automatic Category Classification: feat, fix, docs, refactor, etc.
  • Semantic Versioning: Estimate version from changes
  • Markdown/HTML Output: Supports multiple formats
  • Automatic Link Generation: Links to Issues, PRs, and Commits
  • Breaking Changes Detection: Highlight incompatible changes
  • Contributors List: Automatic contributor extraction
  • Release Notes: Generate press release format

Usage

Basic Changelog Generation

Gitコミット履歴からChangelogを生成:
期間: v1.0.0..HEAD
形式: Keep a Changelog

Detailed Settings

Changelogを生成:
- 期間: 2024-01-01..2024-06-30
- 形式: Conventional Commits
- グループ化: タイプ別
- リンク: GitHub Issue, PR
- 貢献者リスト: 含める

Output Example

Keep a Changelog Format

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [2.1.0] - 2024-06-15

### Added
- User authentication with JWT tokens (#123)
- Real-time notifications via WebSocket (#145)
- Dark mode support (#156)
- Export data to CSV feature (#167)

### Changed
- Improved search algorithm performance by 60% (#134)
- Updated UI design for better accessibility (#142)
- Migrated from REST to GraphQL for user API (#151)

### Fixed
- Fixed memory leak in file upload (#128)
- Resolved CORS issues on production (#139)
- Fixed pagination bug in user list (#147)

### Security
- Updated dependencies with known vulnerabilities (#155)
- Implemented rate limiting on API endpoints (#161)

### Deprecated
- `/api/v1/users` endpoint (use `/api/v2/users` instead) (#149)

## [2.0.0] - 2024-03-20

### Added
- Complete redesign of the admin dashboard
- Multi-language support (EN, JP, ES, FR)
- Two-factor authentication

### Changed
- **BREAKING**: Changed API response format from XML to JSON
- **BREAKING**: Renamed `getUserData()` to `fetchUser()`
- Minimum Node.js version is now 18.x

### Removed
- **BREAKING**: Removed deprecated `/api/legacy` endpoints
- Dropped support for IE11

## [1.5.2] - 2024-01-10

### Fixed
- Critical bug in payment processing
- Session timeout issues

## Contributors

Thank you to all contributors who made this release possible:
- @john-doe (15 commits)
- @jane-smith (12 commits)
- @developer123 (8 commits)

[Unreleased]: https://github.com/user/repo/compare/v2.1.0...HEAD
[2.1.0]: https://github.com/user/repo/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/user/repo/compare/v1.5.2...v2.0.0
[1.5.2]: https://github.com/user/repo/releases/tag/v1.5.2

Conventional Commits Format

# Release Notes - v2.1.0

**Release Date**: 2024-06-15

## 🚀 Features

- **auth**: Add JWT authentication system ([#123](https://github.com/user/repo/pull/123))
  - Implement token generation and validation
  - Add refresh token mechanism
  - Session management improvements

- **notifications**: Real-time WebSocket notifications ([#145](https://github.com/user/repo/pull/145))
  - Push notifications for important events
  - Configurable notification preferences

- **ui**: Dark mode support ([#156](https://github.com/user/repo/pull/156))
  - Theme toggle in user settings
  - Persists user preference

## 🐛 Bug Fixes

- **upload**: Fix memory leak in file upload handler ([#128](https://github.com/user/repo/pull/128))
- **api**: Resolve CORS configuration issues ([#139](https://github.com/user/repo/pull/139))
- **pagination**: Fix off-by-one error in user list ([#147](https://github.com/user/repo/pull/147))

## ⚡ Performance

- **search**: Improve search algorithm (60% faster) ([#134](https://github.com/user/repo/pull/134))
- **database**: Add indexes to frequently queried columns

## 📝 Documentation

- **api**: Update API documentation with new endpoints
- **readme**: Add contribution guidelines
- **examples**: Add code examples for authentication

## 🔒 Security

- **deps**: Update vulnerable dependencies ([#155](https://github.com/user/repo/pull/155))
- **api**: Implement rate limiting ([#161](https://github.com/user/repo/pull/161))

## 🎨 Refactoring

- **components**: Reorganize React components structure
- **types**: Improve TypeScript type definitions

## ⚠️ Breaking Changes

None in this release

## 📊 Statistics

- **Commits**: 47
- **Contributors**: 8
- **Files Changed**: 156
- **Lines Added**: 3,421
- **Lines Removed**: 1,892

## 🙏 Contributors

- @john-doe - 15 commits
- @jane-smith - 12 commits
- @developer123 - 8 commits
- @contributor456 - 6 commits
- @newbie789 - 3 commits
- @bugfixer - 2 commits
- @docs-writer - 1 commit

Conventional Commits Types

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation
  • style: Code style (formatting, etc.)
  • refactor: Refactoring
  • perf: Performance improvements
  • test: Adding/fixing tests
  • chore: Build, tools, etc.
  • ci: CI configuration
  • build: Build System
  • revert: Revert changes

Customization

Changelogを生成:

設定:
- スコープ: v2.0.0..v2.5.0
- 除外: "chore", "style"
- グループ化: モジュール別
- フォーマット: HTML
- テンプレート: カスタム
- Breaking Changes: 別セクションで強調
- リンク先: GitHub

Integration

GitHub Release

GitHub Releaseノートを生成:
タグ: v2.1.0
含める:
- What's Changed
- New Contributors
- Full Changelog link

NPM/PyPI

npm/PyPI用のリリースノート生成:
バージョン: 2.1.0
ハイライト: 主要な機能と修正
インストール手順含む

Best Practices

  1. Use Conventional Commits: Easy to automate
  2. Semantic Versioning: Give meaning to version numbers
  3. Regular Updates: Update with each release
  4. User Perspective: Describe impact rather than technical details
  5. State Breaking Changes Clearly: Provide upgrade guide

Version Information

  • Skill Version: 1.0.0
  • Last updated: 2025-01-22

Usage Example:

最新リリースのChangelogを生成:
- 形式: Keep a Changelog
- 前回タグ: v2.0.0
- 現在: HEAD
- GitHub リンク含む
- 貢献者リスト含む

A complete Changelog will be generated!