用途:按照 SemVer 原则自动化版本管理与变更日志(changelog)生成,用于实现版本编号规范、自动发布版本、生成 CHANGELOG、搭建发布流水线和管理包版本。
版本格式:MAJOR.MINOR.PATCH[-PRERELEASE][+BUILD],如 1.0.0、1.0.0-alpha.1、1.0.0-beta.2+build.123。MAJOR 用于破坏性变更,MINOR 用于向后兼容的新功能,PATCH 用于向后兼容的缺陷修复;PRERELEASE 为预发布(alpha、beta、rc),BUILD 为构建元数据且不参与优先级比较。
前提条件:带提交历史的 Git 仓库、Node.js(多数工具需要)、推荐使用 Conventional Commits。提交类型与版本递增对应:feat→MINOR,fix/docs/style/refactor/perf→PATCH(部分可不发版),test/chore→不发版,BREAKING CHANGE 或 feat!、fix!→MAJOR。
主要能力与用法:
- semantic-release:安装命令为 npm install --save-dev semantic-release @semantic-release/changelog @semantic-release/git,通过 .releaserc.json 或 release.config.js 配置分支与插件(commit-analyzer、release-notes-generator、changelog、npm、git、github),可在 GitHub Actions 中通过 npx semantic-release 触发发布。
- standard-version:安装 npm install --save-dev standard-version,使用 npx standard-version 自动判断版本递增,支持 --first-release、--release-as minor、--prerelease alpha、--dry-run、--skip.changelog 等,可写入 package.json 的 scripts。
- 变更日志:conventional-changelog 命令如 conventional-changelog -p angular -i CHANGELOG.md -s;git-cliff 用 cargo install git-cliff 安装并运行 git cliff -o CHANGELOG.md,通过 cliff.toml 配置分组与提交解析。
- 还提供版本递增的 Bash 与 Python 脚本示例。
限制:指南在真实环境中执行,应用前需确认目标、影响范围与回滚方案;未经明确批准不得部署到生产环境。本文档为仅文档导入,上游脚本与模板未随包提供。多包版本管理、常见问题与最佳实践章节内容未在资料中展开。