什么是 shipjs?
shipjs 是一款 npm 包,用于自动化地进行软件发布。它能够自动执行版本号的变更、生成 changelog、打 tag、提取发布更新等操作。这款工具能够帮助开发人员专注于编写代码,同时减少重复性的操作。
安装 shipjs
在使用 shipjs 之前,需要先安装它。
npm install --save-dev shipjs
同时,也需要通过配置文件将 shipjs 引入你的项目中:
-- -------------------- ---- ------- -- ------------ - -------------- ----- --- ------ --------------- ----- --- ------- ----------------- ----- --------- ----------------- - ----- --- ------ -- -------- - ------------- ----------- -- ----------------- -- ------------ ------------- -
shipjs 的基本使用
完成 shipjs 的安装和配置后,你可以通过以下步骤使用 shipjs 进行软件发布:
- 执行以下命令启动 shipjs:
yarn shipjs trigger
- 在 shipjs 的交互式命令行中,按提示进行操作,即可完成软件发布。
shipjs 会自动地执行版本号的变更、生成 changelog、打 tag 等操作,减少了发布软件的重复性工作。
shipjs 的常用配置
除了最基本的使用外,shipjs 还支持多种配置,用于满足不同的需求。
testBranches
testBranches
配置项用于配置在哪些分支上运行测试。默认值是 ["master"]
,即在 master 分支上执行测试。
// .shiprc.json { "testBranches": [ "master", "dev" ] }
prereleaseBranches
prereleaseBranches
配置项用于配置哪些分支应该被发行一个预发布版本。默认值是 ["next", "beta", "alpha", "canary"]
,即 next、beta、alpha 和 canary 分支会被认为是预发布分支。
// .shiprc.json { "prereleaseBranches": [ "preview" ] }
releaseBranches
releaseBranches
配置项用于配置需要进行发行的分支。默认情况下,添加了 semver 标签(例如 1.2.3)的本地 Git 分支将被视为进行发布的分支。
// .shiprc.json { "releaseBranches": [ "production" ] }
noVerify
noVerify
配置项用于配置是否验证 Git 提交信息的格式。默认是 false
,即需要对提交信息的格式进行验证。
// .shiprc.json { "noVerify": true }
tagFormat
tagFormat
配置项用于配置 semver 标签的格式。默认是 v${VERSION}
。
// .shiprc.json { "tagFormat": "version-${VERSION}" }
versionUpdated
versionUpdated
配置项用于增加自定义的命令,在执行 shipjs version
后就会自动执行。
// .shiprc.json { "versionUpdated": [ "git add package.json" ] }
总结
shipjs 是一个非常有用的 npm 包,它能够自动化地进行软件发布。本篇文章介绍了 shipjs 的安装和基本使用,以及常见的配置项,希望能够帮助前端开发人员更加高效地完成软件发布。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedcc3cb5cbfe1ea0612712