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