Changelog Automation

作者 wshobson46891e7e60da無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Automate changelog generation from commits, PRs, and releases following Keep a Changelog format. Use when setting up release workflows, generating release notes, or standardizing commit conventions.

僅含說明DevOps & Cloud Software Development

AI 產生的概覽

指導依提交、PR 與發布自動產生變更日誌與發布說明，遵循 Keep a Changelog 與約定式提交規範。

功能: 此技能提供自動產生變更日誌、發布說明與版本管理的模式與慣例。它記錄 Keep a Changelog 格式、約定式提交的訊息範例，以及統一提交規範與語意化版本的最佳實務。它也會指向一份包含詳細模式與範例的參考檔案。產出的是指引與範本，而非執行程式碼。
適用情境: 適用於建立發布流程、產生發布說明或統一提交訊息規範的情境。適合採用約定式提交、語意化版本或自動化 GitHub、GitLab 發布說明的團隊。
執行需求: 不需要指令碼或工具，僅為說明與參考文件。閱讀隨附的參考檔案為選用。

Changelog Automation

Patterns and tools for automating changelog generation, release notes, and version management following industry standards.

When to Use This Skill

Setting up automated changelog generation
Implementing Conventional Commits
Creating release note workflows
Standardizing commit message formats
Generating GitHub/GitLab release notes
Managing semantic versioning

Core Concepts

1. Keep a Changelog Format

markdown

# 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.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Detailed patterns and worked examples
Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
## Summary
This release introduces dark mode support and improves checkout performanceby 40%. It also includes important security updates.
## Highlights
### 🌙 Dark Mode
Users can now switch to dark mode from settings. The preference isautomatically saved and synced across devices.
### ⚡ Performance
- Checkout flow is 40% faster- Reduced bundle size by 15%
## Breaking Changes
None in this release.
## Upgrade Guide
No special steps required. Standard deployment process applies.
## Known Issues
- Dark mode may flicker on initial load (fix scheduled for v2.1.1)
## Dependencies Updated
| Package | From    | To      | Reason                   || ------- | ------- | ------- | ------------------------ || react   | 18.2.0  | 18.3.0  | Performance improvements || lodash  | 4.17.20 | 4.17.21 | Security patch           |

# 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.1.0/),and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Detailed patterns and worked examples
Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient.
## Summary
This release introduces dark mode support and improves checkout performanceby 40%. It also includes important security updates.
## Highlights
### 🌙 Dark Mode
Users can now switch to dark mode from settings. The preference isautomatically saved and synced across devices.
### ⚡ Performance
- Checkout flow is 40% faster- Reduced bundle size by 15%
## Breaking Changes
None in this release.
## Upgrade Guide
No special steps required. Standard deployment process applies.
## Known Issues
- Dark mode may flicker on initial load (fix scheduled for v2.1.1)
## Dependencies Updated
| Package | From    | To      | Reason                   || ------- | ------- | ------- | ------------------------ || react   | 18.2.0  | 18.3.0  | Performance improvements || lodash  | 4.17.20 | 4.17.21 | Security patch           |

Commit Message Examples

bash

# Feature with scopefeat(auth): add OAuth2 support for Google login
# Bug fix with issue referencefix(checkout): resolve race condition in payment processing
Closes #123
# Breaking changefeat(api)!: change user endpoint response format
BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.Migration guide: Update all API consumers to use the new field name.
# Multiple paragraphsfix(database): handle connection timeouts gracefully
Previously, connection timeouts would cause the entire request to failwithout retry. This change implements exponential backoff with up to3 retries before failing.
The timeout threshold has been increased from 5s to 10s based on p99latency analysis.
Fixes #456Reviewed-by: @alice

# Feature with scopefeat(auth): add OAuth2 support for Google login
# Bug fix with issue referencefix(checkout): resolve race condition in payment processing
Closes #123
# Breaking changefeat(api)!: change user endpoint response format
BREAKING CHANGE: The user endpoint now returns `userId` instead of `id`.Migration guide: Update all API consumers to use the new field name.
# Multiple paragraphsfix(database): handle connection timeouts gracefully
Previously, connection timeouts would cause the entire request to failwithout retry. This change implements exponential backoff with up to3 retries before failing.
The timeout threshold has been increased from 5s to 10s based on p99latency analysis.
Fixes #456Reviewed-by: @alice

Best Practices

Do's

Follow Conventional Commits - Enables automation
Write clear messages - Future you will thank you
Reference issues - Link commits to tickets
Use scopes consistently - Define team conventions
Automate releases - Reduce manual errors

Don'ts

Don't mix changes - One logical change per commit
Don't skip validation - Use commitlint
Don't manual edit - Generated changelogs only
Don't forget breaking changes - Mark with ! or footer
Don't ignore CI - Validate commits in pipeline

來源與署名

來源：wshobson/agents位於plugins/documentation-generation/skills/changelog-automation提交46891e7

授權條款：無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

Changelog Automation

Changelog Automation

When to Use This Skill

Core Concepts

1. Keep a Changelog Format

Commit Message Examples

Best Practices

Do's

Don'ts

來源與署名

更多來自 wshobson/agents 的技能

Uv Package Manager

Web Component Design

Python Type Safety

Visual Design Foundations

Responsive Design

Python Resource Management

更多DevOps & Cloud技能

M5 Onboard

Runbook

Incident Response

Deploy Checklist

Spanner Basics

Secops Cases