本项目使用 standard-version 进行版本控制,遵循语义化版本规范。
版本格式:主版本号.次版本号.修订号,版本号递增规则如下:
- 主版本号:当你做了不兼容的 API 修改
- 次版本号:当你做了向下兼容的功能性新增
- 修订号:当你做了向下兼容的问题修正
本项目使用 Conventional Commits 规范来规范提交信息格式。提交信息应该遵循以下格式:
<类型>[可选的作用域]: <描述>
[可选的正文]
[可选的脚注]
常用的提交类型:
feat: 新功能fix: 修复Bugdocs: 文档更新style: 代码格式调整,不影响代码功能refactor: 代码重构,既不是新增功能,也不是修改bug的代码变动perf: 性能优化test: 测试相关build: 构建系统或外部依赖项的更改ci: CI配置文件和脚本的更改chore: 其他不修改src或测试文件的更改
# 根据提交记录自动确定版本类型并更新
npm run release
# 指定版本类型
npm run release:patch # 更新修订号 (1.0.0 -> 1.0.1)
npm run release:minor # 更新次版本号 (1.0.0 -> 1.1.0)
npm run release:major # 更新主版本号 (1.0.0 -> 2.0.0)执行上述命令会:
- 根据提交记录自动更新版本号
- 生成/更新 CHANGELOG.md 文件
- 创建带有版本号的 git 标签
- 提交上述更改
如果这是项目的首次发布,可以使用以下命令:
npm run release -- --first-release这将创建 CHANGELOG.md 文件而不更改版本号。