关于 semantic-versioning
semantic-versioning 是一项帮助团队制定语义化版本规范的技能,涵盖版本管理、发布说明和破坏性变更跟踪。适用于软件包、库及 API 的发布流程。
主要功能
- 01规范 MAJOR.MINOR.PATCH 版本号
- 02使用 Conventional Commits
- 03自动化版本递增
- 04生成变更日志
- 05记录破坏性变更
适用场景
- 01管理软件包和库的版本发布
- 02维护 API 版本
- 03自动递增版本并生成发布说明
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ aj-geddes/ useful-ai-prompts --skill semantic-versioning安装后在 Claude Code 中输入/semantic-versioning确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/changelog-generation.mdconventional-commits-format.mdsemantic-release-configuration.mdsemantic-versioning-configuration.mdversion-bumping-script.mdscripts/validate-api.shtemplates/api-scaffold.yaml详细介绍
语义化版本
目录
概述
建立语义化版本实践,确保版本编号与发布的重要程度保持一致,从而实现版本管理和发布说明生成的自动化。
适用场景
- 软件包和库的发布
- API 版本管理
- 自动更新版本号
- 生成发布说明
- 跟踪破坏性变更
- 依赖管理
- 变更日志管理
快速入门
最简可运行示例:
# package.json
{
"name": "my-awesome-package",
"version": "1.2.3",
"description": "An awesome package",
"main": "dist/index.js",
"repository": { "type": "git", "url": "https://github.com/org/repo.git" },
"scripts": { "release": "semantic-release" },
"devDependencies":
{
"semantic-release": "^21.0.0",
"@semantic-release/changelog": "^6.0.0",
"@semantic-release/git": "^10.0.0",
"@semantic-release/github": "^9.0.0",
"conventional-changelog-cli": "^3.0.0",
},
}
参考指南
references/ 目录中的详细实现:
| 指南 | 内容 |
|---|---|
| 语义化版本配置 | 语义化版本配置 |
| Conventional Commits 格式 | Conventional Commits 格式 |
| Semantic Release 配置 | Semantic Release 配置 |
| 版本更新脚本 | 版本更新脚本 |
| 变更日志生成 | 变更日志生成 |
最佳实践
✅ 应该
- 严格遵循 MAJOR.MINOR.PATCH 格式
- 使用 Conventional Commits
- 自动更新版本号
- 自动生成变更日志
- 在 git 中为发布打标签
- 记录破坏性变更
- 使用预发布版本进行测试
❌ 不应该
- 手动更新版本号且不遵循一致规则
- 跳过破坏性变更文档
- 使用随意的版本编号
- 在补丁版本发布中混入新功能
评论
支持 Markdown