语义 - 释放 - pnpm
| 步骤 | 说明 |
|---|---|
verifyConditions | 验证是否存在 NPM_TOKEN 环境变量,或 .npmrc 文件,并验证认证方法有效. |
prepare | 更新 package.json 版本和 创建 npm包装柏油球. |
addChannel | 将释放添加到 Dist- tag。 。 。 . |
publish | 发布 npm 软件包 登记. |
安装
$ npm install @colbyfayock/semantic-release-pnpm -D
使用量
插件可以在 语义释放 配置文件数字 :
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@colbyfayock/semantic-release-pnpm",
]
}
配置
Npm 注册认证
Npm 认证配置为 所需经费 并可以通过 环境变量。 。 。 .
两者 符号 遗产问题username, (中文(简体) ), password 财务报告和审定财务报表 email) 认证得到支持。 建议使用 符号 认证。 遗留的认证作为替代 npm 登记册支持 艺术 财务报告和审定财务报表 npm- registry- couchapp (英语) 只支持这种认证形式.
页:1数字 :
- 只有
auth-onlynpm 二要素认证级别 得到支持, 语义释放 将不对默认值工作auth-and-writes级别. - 存在
.npmrc文件将覆盖任何指定的环境变量.
环境变量
| 变量 | 说明 |
|---|---|
NPM_TOKEN | 通过 Npm 符号创建 npm 符号创建 |
NPM_USERNAME | 通过 Npm 创建用户名 npm 添加用户 或继续 npmjs.com (英语) |
NPM_PASSWORD | Npm 用户密码 . |
NPM_EMAIL | Npm 用户的电子邮件地址 |
NPM_CONFIG_USERCONFIG | 非默认 . npmrc 文件的路径 |
使用其中之一 NPM_TOKEN 用于符号认证或 NPM_USERNAME, (中文(简体) ), NPM_PASSWORD 财务报告和审定财务报表 NPM_EMAIL 遗留认证
选项
| 选项 | 说明 | 默认 |
|---|---|---|
npmPublish | 是否发布 npm 软件包。 若为 false 页:1 package.json 版本仍将更新. | false 若为 package.json 私营 属性是 true, (中文(简体) ), true 否则. |
pkgRoot | 要发布的目录路径 . | . |
tarballDir | 用于写包沥青球的目录路径 。 若为 false 文件系统不保存柏油球. | false |
publishBranch | 用于发布最新变化的寄存器主分支. | 大师和主 |
说明编号: pkgRoot 目录必须包含 package.json。该版本将在 package.json 财务报告和审定财务报表 npm-shrinkwrap.json 内部 pkgRoot 目录.
说明: 如果使用 可共享配置 定义其中之一的选项,您可以设置为 false 在你身边 语义释放 配置 以使用默认值.
Npm 配置
该插件使用 pnpm 国 际 读取配置 .npmrc。见 npm config 用于选项列表.
这个 registry 可以通过 npm 环境变量配置 NPM_CONFIG_REGISTRY 并优先于 .npmrc。 。 。 .
这个 registry 财务报告和审定财务报表 dist-tag 可以在 package.json 并优先于 .npmrc 财务报告和审定财务报表 NPM_CONFIG_REGISTRY数字 :
{
"publishConfig": {
"registry": "https://registry.npmjs.org/",
"tag": "latest"
}
}
实例
这个 npmPublish 财务报告和审定财务报表 tarballDir 选项可以用来跳过发布到 npm 注册,然后用另一个插件释放包式柏油球。 例如,与 @semantic-release/ github (英语) 插件 :
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@colbyfayock/semantic-release-pnpm", {
"npmPublish": false,
"tarballDir": "dist",
}],
["@semantic-release/github", {
"assets": "dist/*.tgz"
}]
]
}
当从一个子目录中出版时 pkgRoot 选项 package.json 财务报告和审定财务报表 npm-shrinkwrap.json 使用新版本更新的可移动到另一个带有 postversion。例如,与 @semantic-release/ git (英语) 插件 :
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@colbyfayock/semantic-release-pnpm", {
"pkgRoot": "dist",
}],
["@semantic-release/git", {
"assets": ["package.json", "npm-shrinkwrap.json"]
}]
]
}
{
"scripts": {
"postversion": "cp -r package.json .. && cp -r npm-shrinkwrap.json .."
}
}