简介
publish-please 是一个 NPM 包发布工具，它可以简化包的发布流程。使用 publish-please 工具，你可以在发布 npm 包前进行自动化检查，例如是否有未提交的代码或者是否需要升级版本号；在发布时还可以自动地执行测试、打标签、更新 changelog 等操作。
安装
通过 npm 安装 publish-please：
npm install -g publish-please
使用
初始化
使用 publish-please，首先需要在项目中初始化配置文件：
publish-please init
这条命令将会在当前项目根目录下生成一个名为 publish.config.js 的文件，用于存放 publish-please 的配置信息。配置文件中包含了项目名称、版本号和要执行的脚本等信息。
发布
接下来就可以使用 publish-please 进行发布了：
publish-please
这个命令将会自动完成以下任务：
- 检查是否有未提交的代码
- 检查当前分支是否与远程同步
- 检查版本号是否存在冲突
- 执行测试
- 打标签并推送到远程
- 更新 changelog 并推送到远程
- 将新版本发布到 npm
如果你不想进行所有的操作，也可以通过参数选择只执行其中的一些操作。例如，如果只想运行测试并发布到 npm，可以使用以下命令：
publish-please --test --npm
配置
通过修改 publish.config.js 文件可以对 publish-please 进行配置。以下是一个例子：
-- -------------------- ---- ------- -------------- - - ----------------- - ------------------------------ ------------------------ -------------------------- -- -------- - - ----- ------------------------------ -------------- -------------- -- ------------------------ - ----- ------------------------ ------- ---------------- ---------------- -------- ---------------- ---------------------- ----- ---------------------------- - -- -------- - ------------------------ - ----- --------------------------- ------- - - ----- ------------ ------ ----------- ------- -- - ----- ------------- ------ ---- ------- - - - - --展开代码
这个配置文件中定义了三个阶段的任务：verifyConditions、prepare 和 publish。在每个阶段中都可以执行多个任务，这些任务将按照顺序依次执行。
例如，在 prepare 阶段中，执行了三个任务：
- @semantic-release/changelog：生成新的 changelog。
- @semantic-release/npm：更新 package.json 文件并生成并推送到 npm。
- @semantic-release/git：提交代码并打上标签，将 changelog 和 package.json 文件一起提交到 git。
总结
使用 publish-please 可以简化 NPM 包发布流程，减少手动操作，提高效率。在使用过程中，需要注意配置文件的编写和命令行参数的传递。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/44112
