# @colbyfayock/semantic-release-pnpm 中文文档 规范地址：https://npmcn.com/package/%40colbyfayock/semantic-release-pnpm/ 版本：1\.2\.2 npm 元数据更新时间：2023-12-15T01:34:50.265Z 中文译文更新时间：2026-11-10T10:39:59.388Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40colbyfayock/semantic-release-pnpm 原文对照：https://npmcn.com/package/%40colbyfayock/semantic-release-pnpm/?lang=original 项目主页：https://github.com/colbyfayock/semantic-release-pnpm 源码仓库：https://github.com/colbyfayock/semantic-release-pnpm ## 关键信息（来自 npm 元数据） - 包体积（解压后）：28.7 kB，17 个文件 - 模块格式：CommonJS - TypeScript 类型：未声明 - Node.js 要求：\>=16 \|\| ^14\.17 - 运行依赖：12 个 - peer 依赖：semantic-release \>=19\.0\.0 - 首次发布：2023-02-02T14:14:17.407Z - 最新版本发布：2023-12-15T01:34:50.086Z - 近 30 天下载量：7817（2026-10-11 至 2026-11-09，npm 官方下载统计） - 已发布版本数：11（近 12 个月 0 个） ## 中文简介 pnpm 语义释放插件以发布 npm 包 ## 安装 ```sh npm install @colbyfayock/semantic-release-pnpm ``` 也可以使用：`pnpm add @colbyfayock/semantic-release-pnpm`、`yarn add @colbyfayock/semantic-release-pnpm`、`bun add @colbyfayock/semantic-release-pnpm` ## README # 语义 - 释放 - pnpm [**语义释放**](https://github.com/semantic-release/semantic-release) 发布一个插件 [无](https://www.npmjs.com/) 带有 pnpm 的软件包. | 步骤 | 说明 | | --- | --- | | `verifyConditions` | 验证是否存在 `NPM_TOKEN` 环境变量,或 `.npmrc` 文件,并验证认证方法有效. | | `prepare` | 更新 `package.json` 版本和 [创建](https://docs.npmjs.com/cli/pack) npm包装柏油球. | | `addChannel` | [将释放添加到 Dist- tag](https://docs.npmjs.com/cli/dist-tag)。 。 。 . | | `publish` | [发布 npm 软件包](https://docs.npmjs.com/cli/publish) 登记. | ## 安装 ```bash $ npm install @colbyfayock/semantic-release-pnpm -D ``` ## 使用量 插件可以在 [**语义释放** 配置文件](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration)数字 : ```json { "plugins": [ "@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@colbyfayock/semantic-release-pnpm", ] } ``` ## 配置 ### Npm 注册认证 Npm 认证配置为 **所需经费** 并可以通过 [环境变量](https://npmcn.com/package/%40colbyfayock/semantic-release-pnpm/#readme-environment-variables)。 。 。 . 两者 [符号](https://docs.npmjs.com/getting-started/working_with_tokens) 遗产问题`username`, (中文(简体) ), `password` 财务报告和审定财务报表 `email`) 认证得到支持。 建议使用 [符号](https://docs.npmjs.com/getting-started/working_with_tokens) 认证。 遗留的认证作为替代 npm 登记册支持 [艺术](https://www.jfrog.com/open-source/#os-arti) 财务报告和审定财务报表 [npm- registry- couchapp (英语)](https://github.com/npm/npm-registry-couchapp) 只支持这种认证形式. **页:1**数字 : - 只有 `auth-only` [npm 二要素认证级别](https://docs.npmjs.com/getting-started/using-two-factor-authentication#levels-of-authentication) 得到支持, **语义释放** 将不对默认值工作 `auth-and-writes` 级别. - 存在 `.npmrc` 文件将覆盖任何指定的环境变量. ### 环境变量 | 变量 | 说明 | | --- | --- | | `NPM_TOKEN` | 通过 Npm 符号创建 [npm 符号创建](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) | | `NPM_USERNAME` | 通过 Npm 创建用户名 [npm 添加用户](https://docs.npmjs.com/cli/adduser) 或继续 [npmjs.com (英语)](https://www.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` [私营](https://docs.npmjs.com/files/package.json#private) 属性是 `true`, (中文(简体) ), `true` 否则. | | `pkgRoot` | 要发布的目录路径 . | `.` | | `tarballDir` | 用于写包沥青球的目录路径 。 若为 `false` 文件系统不保存柏油球. | `false` | | `publishBranch` | 用于发布最新变化的寄存器主分支. | [大师和主](https://pnpm.io/cli/publish#--publish-branch-branch) | **说明**编号: `pkgRoot` 目录必须包含 `package.json`。该版本将在 `package.json` 财务报告和审定财务报表 `npm-shrinkwrap.json` 内部 `pkgRoot` 目录. **说明**: 如果使用 [可共享配置](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/shareable-configurations.md#shareable-configurations) 定义其中之一的选项,您可以设置为 `false` 在你身边 [**语义释放** 配置](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) 以使用默认值. ### Npm 配置 该插件使用 [`pnpm` 国 际](https://pnpm.io/pnpm-cli) 读取配置 [`.npmrc`](https://docs.npmjs.com/files/npmrc)。见 [`npm config`](https://docs.npmjs.com/misc/config) 用于选项列表. 这个 [`registry`](https://docs.npmjs.com/misc/registry) 可以通过 npm 环境变量配置 `NPM_CONFIG_REGISTRY` 并优先于 `.npmrc`。 。 。 . 这个 [`registry`](https://docs.npmjs.com/misc/registry) 财务报告和审定财务报表 [`dist-tag`](https://docs.npmjs.com/cli/dist-tag) 可以在 `package.json` 并优先于 `.npmrc` 财务报告和审定财务报表 `NPM_CONFIG_REGISTRY`数字 : ```json { "publishConfig": { "registry": "https://registry.npmjs.org/", "tag": "latest" } } ``` ### 实例 这个 `npmPublish` 财务报告和审定财务报表 `tarballDir` 选项可以用来跳过发布到 `npm` 注册,然后用另一个插件释放包式柏油球。 例如,与 [@semantic-release/ github (英语)](https://github.com/semantic-release/github) 插件 : ```json { "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 (英语)](https://github.com/semantic-release/git) 插件 : ```json { "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"] }] ] } ``` ```json { "scripts": { "postversion": "cp -r package.json .. && cp -r npm-shrinkwrap.json .." } } ``` ## 常见问题 ### @colbyfayock/semantic-release-pnpm 是什么？ pnpm 语义释放插件以发布 npm 包 ### 如何安装 @colbyfayock/semantic-release-pnpm？ 在项目目录运行 npm install @colbyfayock/semantic-release-pnpm，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：semantic-release（\>=19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @colbyfayock/semantic-release-pnpm 支持 TypeScript 吗？ 该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/colbyfayock\_\_semantic-release-pnpm 是否存在。 ### @colbyfayock/semantic-release-pnpm 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @colbyfayock/semantic-release-pnpm 需要什么版本的 Node\.js？ package\.json 的 engines 字段要求 Node\.js \>=16 \|\| ^14\.17。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。 ### @colbyfayock/semantic-release-pnpm 可以商用吗？ @colbyfayock/semantic-release-pnpm 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @colbyfayock/semantic-release-pnpm 的下载量有多少？ 根据 npm 官方下载统计，@colbyfayock/semantic-release-pnpm 在 2026/10/11 – 2026/11/09 这 30 天内被下载 7,817 次，日均约 261 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @colbyfayock/semantic-release-pnpm 还在维护吗？ 最新版本 1\.2\.2 发布于 2023/12/15（2 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/02/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。