开发工具DevOps【免费下载链接】release-it Automate versioning and package publishing项目地址https://gitcode.com/gh_mirrors/re/release-it点击查看免费下载导读release-it是一款自动化版本号管理、Git 标签/提交、Changelog 生成与 npm/GitHub/GitLab 发布的工具。在真正执行一次发布之前你可能希望先预览它会执行哪些命令会修改哪些文件交互式提示长什么样docs/dry-runs.md中介绍的Dry Run干运行模式正是为此而生。阅读本文后你将掌握--dry-run、--release-version、--changelog三个核心标志的用法、$与!输出符号的确切含义以及从源码层面理解 release-it 如何区分只读命令与写操作命令。一、Dry Run 是什么Dry Run 是 release-it 提供的一种零风险预览模式它完整模拟一次版本发布的流程包括版本递增、Git 操作、发布平台调用、交互提示但不实际写入任何内容。在 lib/cli.js 的帮助文本中--dry-run短别名-d的官方描述是Do not touch or write anything, but show the commands即不触碰、不写入任何内容只展示将要执行的命令。该标志在 lib/args.js 中被注册为d: dry-run并在 lib/config.js 中通过isDryRungetter 暴露给整个运行时使用。二、基本用法release-it --dry-run在项目根目录直接运行release-it --dry-runrelease-it 会展示完整的交互过程以及它本将要执行的命令。典型输出形如$ git rev-parse --git-dir .git ! git add package.json ! git commit --messageRelease 0.8.3关键点在于输出前缀符号的语义$ ...表示这是一条只读命令它仍然会被真实执行例如git rev-parse --git-dir、git log等读取性操作! ...表示这是一条潜在的写入/变更命令在 dry-run 模式下不会被执行例如git add、git commit、git push等。三、源码级原理$与!是如何产生的3.1 写操作拦截点lib/shell.jsrelease-it 所有外部命令git、npm 等都经由 lib/shell.js 中的execFormattedCommand统一执行。核心逻辑如下const { isDryRun } this.config; const isWrite options.write ! false; // 未显式声明 write: false 的命令都被视为写操作 if (isDryRun isWrite) { this.log.exec(command, { isDryRun }); // 只记录命令不真正执行 return noop; }也就是说在 dry-run 模式下凡是options.write未显式设为false的命令都会被拦截——release-it不会调用child_process去执行它而是立即返回一个已决议的 Promise并把命令交给 Logger 输出。3.2 前缀符号生成点lib/log.js命令前缀$或!由 lib/log.js 的exec方法生成const prefix isExecutedInDryRun null ? $ : !;当命令是通过 dry-run 拦截标记即isExecutedInDryRun非空打印时前缀为!当命令是正常记录只读命令时前缀为$。因此前缀!不是命令本身的属性而是 dry-run 拦截的结果——只有被判定为写操作且未执行的命令才会被打上!标记。3.3 哪些命令被声明为只读从源码结构看各插件通过{ write: false }显式声明只读命令lib/plugin/git/Git.jsGit 插件的默认执行选项const options { write: false }即git rev-parse、git log、git tag --list等读取类命令照常执行用于获取真实的仓库信息lib/plugin/npm/npm.jsgetOptions返回{ write: false, env: getNpmEnv() }用于npm view、npm dist-tag ls等只读查询。而git add、git commit、git push等命令在 Git 插件的release()流程lib/plugin/git/Git.js中通过this.step(...)执行默认视为写操作因此在 dry-run 下只打印!前缀命令而不真正执行。四、Dry Run 模式下各发布平台的降级行为dry-run 不只是跳过命令从源码看各插件还为 dry-run 提供了短路式假成功路径保证流程能完整走完、不因缺少真实响应而中断GitHub 插件lib/plugin/github/GitHub.jsisAuthenticated与isCollaborator在config.isDryRun为真时直接返回true跳过 API 鉴权createRelease在 dry-run 下打印命令后设置{ isReleased: true, releaseUrl: ... }并返回trueGitHub.jsuploadAssets、updateRelease、publishRelease、commentOnResolvedItems同样只打印octokit ...调用并直接返回GitLab 插件lib/plugin/gitlab/GitLab.jsisAuthenticated、isCollaborator同样在 dry-run 下短路createRelease打印gitlab releases#createRelease后返回true并设置假的发布上下文npm 插件lib/plugin/npm/npm.js发布命令会追加真实的--dry-run参数npm publish ... --dry-run让 npm 自身也进入 dry-run 模式当 npm 返回 publish over the previously published version 之类的错误时dry-run 下也会被吞掉并正常结束同时logWouldStage()会提示 Would stage (dry-run). Approve at ... after a real run.。这保证了你可以在 dry-run 下完整预览 Git、npm、GitHub/GitLab 三个环节的全部操作而不会在鉴权或 API 调用处提前中断。五、只打印版本号--release-version如果你只需要知道下一次会发布哪个版本号而不想看完整流程使用--release-version标志release-it --release-version该标志会计算并打印下一个版本号如1.2.3到标准输出然后立即以成功状态退出不做任何 Git/npm/发布操作。如果当前没有可用的下一个版本则什么都不打印并以成功状态退出exit code 0。这一行为在 lib/index.js 中有明确实现if (isReleaseVersion) { if (version) { console.log(version); } process.exit(0); }该标志非常适合在脚本中捕获版本号NEXT_VERSION$(release-it --release-version) echo 即将发布版本$NEXT_VERSION注意版本计算依赖插件链例如 Git 插件从git describe/ 标签中读取 latest version再根据提交历史与--incrementmajor/minor/patch/pre*计算下一个版本在没有提交时可能拿不到下一个版本此时输出为空。六、只打印 Changelog--changelog如果你只想预览本次发布会生成哪些 Changelog 内容使用--changelog标志release-it --changelog它会打印本次要发布的版本所对应的 Changelog来自 docs/changelog.md 所述的默认git log命令或自定义的git.changelog配置然后退出。与--release-version的差异在于找不到 Changelog 时它会打印警告并以退出码 1 结束而非静默成功lib/index.jsif (isChangelog) { if (changelog) { console.log(changelog); process.exit(0); } else { log.warn(No changelog found); process.exit(1); } }该标志适合在 CI 中生成发布说明草稿或与github.releaseNotes/gitlab.releaseNotes配置联调校验 Changelog 输出。七、组合使用与实战建议7.1 三个标志可以搭配其他参数使用dry-run 与其他 CLI 参数完全兼容例如指定递增级别release-it minor --dry-run release-it --dry-run --incrementpreminor也可以配合--ci无交互在 CI 中做发布预演配合--verbose/-VV查看更详细的内部命令输出参见 lib/cli.js 的完整帮助文本。7.2 何时使用 Dry Run上线前预演发布前先跑一次--dry-run核对将要执行的 git 命令、npm publish 命令与 GitHub/GitLab release 调用是否与预期一致配置联调修改.release-it.json、hooks、插件配置后用 dry-run 验证配置是否被正确解析、hook 是否会触发注意外部 hook 脚本在 dry-run 下仍会执行因为它们属于用户自定义动作这一点在 lib/index.js 的runHook中通过shell.exec(script, { external: true }, ...)调用需要自行留意脚本集成--release-version与--changelog是纯输出型标志适合嵌入 CI 流水线生成版本号与发布说明。7.3 注意事项dry-run 并非绝对零副作用只读命令仍会真实执行如git log、git describe且npm publish --dry-run会触发 npm 自身的校验流程需要保证 Git 工作区干净requireCleanWorkingDir默认开启否则即使 dry-run 也会在初始化阶段报错见 lib/plugin/git/Git.jsdry-run 输出的!命令只是本应执行的预告实际发布时命令参数可能因上下文如推送到哪条分支、上游是否已配置略有差异最终以真实运行为准。八、相关资源本文依据的官方文档docs/dry-runs.mdCLI 参数与帮助文本lib/cli.js、参数解析与别名定义lib/args.js执行与拦截核心lib/shell.js、输出符号生成lib/log.js、运行主流程lib/index.js相关配置说明docs/configuration.md、docs/git.md、docs/github-releases.md、docs/gitlab-releases.md、docs/npm.md赞分享开发工具DevOps【免费下载链接】release-it Automate versioning and package publishing项目地址https://gitcode.com/gh_mirrors/re/release-it点击查看免费下载相关推荐如何安全发布npm包np预览模式与npm publish --dry-run对比指南想要安全发布npm包但担心出错np工具的预览功能为你提供了完整的发布流程预演体验np是一个更智能的npm发布工具通过交互式UI和强大的安全检查机制确保每开发工具CLIPrettier 发布流程全解读懂并运行 scripts/release 发布脚本Prettier 发布流程全解读懂并运行 scripts/release 发布脚本 导读 scripts/release/README.md 是 Pretti开发工具格式化CLIswift run 命令完全指南Swift Package Manager 可执行产品构建与运行实战swift run 命令完全指南Swift Package Manager 可执行产品构建与运行实战 导读 swift run 是 Swift Package开发工具构建工具上一篇DeepSurv超参数优化提升生存预测模型性能的实用技巧下一篇从Helium到Moshi再到PersonaPlexKyutai与NVIDIA语音AI技术栈梳理创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考