OpenClaw Skill - changelog¶
Skill 简介¶
在软件开发过程中,编写和管理发布日志(changelog)是版本管理和发布流程中至关重要的一环。一个清晰、结构良好的 changelog 不仅有助于开发者追踪代码变化,还能帮助用户了解产品的最新功能和修复内容。然而,手动编写 changelog 往往费时费力,且容易出错。OpenClaw Skill 中的 Log 正是为了解决这一问题而设计的。它是一款基于人工智能的 changelog 生成器,能够自动将 git 提交记录转换为易于阅读的发布说明。
Log 的核心目标是通过自动化工具简化发布流程,提高开发效率。它不仅能够从 git 历史中提取信息,还能智能地分类变更内容(如新增功能、修复问题、重大变更等),并根据语义化版本控制(Semantic Versioning)建议合适的版本号。对于不同受众(如开发者、用户、产品经理),它还能生成不同风格的发布说明,从而满足多样化的沟通需求。
主要功能¶
Log 提供了多种实用功能,帮助开发者高效地管理和发布软件版本。以下是它的几个核心功能:
- 自动生成 Changelog
Log 能够自动解析 git 提交记录,并根据提交信息生成结构化的 changelog。它能够识别不同类型的变更(如新增功能、修复问题、重大变更等),并将其分类整理。例如:
bash openclaw chat changelog "Generate changelog from last 10 commits"
输出结果将类似于:
```
## [1.4.0] - 2026-02-16
### Added
- PostgreSQL integration for AI agents
- Checkout failure tracking in Mixpanel
### Changed
- Agent pricing: $9 → $5
### Fixed
- Stripe checkout failing on large configs
- Price ID nonce validation error
```
-
用户友好的发布说明
除了技术性的 changelog,Log 还可以生成面向用户的发布说明。这些说明以非技术性语言总结新功能、修复内容和变更点,帮助用户快速了解产品的最新动态。例如:
bash You: "Release notes for users" Log: [Non-technical summary: what's new, what's fixed, what changed] -
版本号建议
Log 基于变更内容提供语义化版本号建议。如果检测到重大变更,它会建议升级主版本号;如果只是新增功能或修复问题,则会建议升级次版本号或修订版本号。例如:
bash You: "What version should this be?" Log: [Semantic version based on changes: major if breaking, minor if features, patch if fixes] -
发布公告生成
Log 可以生成简洁的发布公告,突出关键亮点。这对于在社交媒体或邮件中发布产品更新非常有用。例如:
bash You: "Write a release tweet" Log: [Concise announcement with key highlights] -
支持多种输出格式
Log 支持多种输出格式,包括 Markdown、JSON 等,方便开发者将 changelog 集成到不同的平台和工具中。
使用场景¶
Log 适用于多种开发场景,以下是几个典型的应用场景:
-
自动化发布流程
在持续集成/持续部署(CI/CD)流程中,Log 可以自动生成 changelog 并将其集成到发布流程中,减少手动操作,提高发布效率。 -
团队协作
对于大型开发团队,Log 可以帮助团队成员快速了解代码库的变更历史和最新动态,促进团队协作。 -
产品发布
在产品发布前,Log 可以生成面向用户的发布说明,帮助产品经理和营销团队准备发布材料。 -
版本管理
Log 可以帮助开发者管理版本号,确保版本号的语义化,避免版本号混乱。 -
开源项目管理
对于开源项目,Log 可以自动生成规范的 changelog,提升项目的专业性和可维护性。
如何使用¶
安装¶
首先,确保你已经安装了 OpenClaw 平台。然后,按照以下步骤安装 Log Skill:
mkdir -p ~/.openclaw/agents/changelog/agent
cp SOUL.md ~/.openclaw/agents/changelog/agent/
openclaw agents add changelog --workspace ~/.openclaw/agents/changelog
配置¶
在安装完成后,你需要将 Log 指向你的 git 仓库。你可以通过以下命令进行配置:
openclaw config changelog --git-repo /path/to/your/repo
使用¶
以下是一些常用的命令示例:
-
生成 changelog:
bash openclaw chat changelog "Generate changelog from last 10 commits" -
生成用户发布的说明:
bash openclaw chat changelog "Release notes for users" -
生成发布公告:
bash openclaw chat changelog "Write a release tweet" -
获取版本号建议:
bash openclaw chat changelog "What version should this be?"
示例¶
示例 1:生成 Changelog¶
openclaw chat changelog "Generate changelog from last 10 commits"
输出:
## [1.4.0] - 2026-02-16
### Added
- PostgreSQL integration for AI agents
- Checkout failure tracking in Mixpanel
### Changed
- Agent pricing: $9 → $5
### Fixed
- Stripe checkout failing on large configs
- Price ID nonce validation error
示例 2:生成用户发布的说明¶
openclaw chat changelog "Release notes for users"
输出:
What's New - Feb 16
Lower pricing: Agent package now $5.
PostgreSQL: Connect your agent to any database.
Checkout fix: Some users couldn't complete payment.
总结¶
Log 是一款功能强大的 changelog 生成工具,能够自动解析 git 提交记录并生成结构化的发布说明。它不仅提高了开发者的效率,还帮助团队更好地管理和沟通版本变更。无论是自动化发布流程、团队协作,还是产品发布和版本管理,Log 都能提供有力的支持。对于那些希望简化发布流程、提升项目管理效率的开发者来说,Log 是一个不可或缺的工具。
通过使用 Log,开发者可以专注于代码编写,而无需花费大量时间在编写和管理 changelog 上。这不仅提升了工作效率,还减少了人为错误,确保发布说明的准确性和一致性。