mcpField
C
changelog-automation

changelog-automation

github.com/wshobson开发41.9k13.9k 次安装2 周前更新
代码仓库

关于 changelog-automation

面向开发者和发布维护者的技能，介绍变更日志生成、发布说明和版本管理实践，涵盖 Conventional Commits、Keep a Changelog 与发布自动化。

主要功能

  1. 01Conventional Commits 指南
  2. 02Keep a Changelog 格式
  3. 03生成发布说明
  4. 04语义化版本管理
  5. 05使用 commitlint 验证提交

适用场景

  1. 01设置自动变更日志生成
  2. 02统一团队提交信息格式
  3. 03创建发布说明工作流
  4. 04在 CI 中验证提交

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/wshobson/agents --skill changelog-automation

安装后在 Claude Code 中输入/changelog-automation确认已加载。

附带文件references/details.md

详细介绍

变更日志自动化

遵循行业标准，实现变更日志生成、发布说明和版本管理自动化的模式与工具。

何时使用本技能

  • 设置自动化变更日志生成
  • 实施 Conventional Commits
  • 创建发布说明工作流
  • 统一提交信息格式
  • 生成 GitHub/GitLab 发布说明
  • 管理语义化版本

核心概念

1. Keep a Changelog 格式
# 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 performance
by 40%. It also includes important security updates.

## Highlights

### 🌙 Dark Mode

Users can now switch to dark mode from settings. The preference is
automatically 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           |

提交信息示例

# Feature with scope
feat(auth): add OAuth2 support for Google login

# Bug fix with issue reference
fix(checkout): resolve race condition in payment processing

Closes #123

# Breaking change
feat(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 paragraphs
fix(database): handle connection timeouts gracefully

Previously, connection timeouts would cause the entire request to fail
without retry. This change implements exponential backoff with up to
3 retries before failing.

The timeout threshold has been increased from 5s to 10s based on p99
latency analysis.

Fixes #456
Reviewed-by: @alice

最佳实践

应该做的
  • 遵循 Conventional Commits - 实现自动化
  • 编写清晰的信息 - 未来的你会感谢你
  • 引用 issue - 将提交关联到工单
  • 一致地使用 scope - 定义团队约定
  • 自动化发布 - 减少手动错误
不应该做的
  • 不要混入多项变更 - 每次提交只包含一个逻辑变更
  • 不要跳过验证 - 使用 commitlint
  • 不要手动编辑 - 仅使用生成的变更日志
  • 不要忘记破坏性变更 - 用 ! 或 footer 标记
  • 不要忽略 CI - 在流水线中验证提交

评论

支持 Markdown