# @brillout/release-me 中文文档

规范地址：https://npmcn.com/package/%40brillout/release-me/

版本：0\.4\.19
npm 元数据更新时间：2026-10-04T18:59:14.992Z
中文译文更新时间：2026-11-08T15:31:02.354Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40brillout/release-me
原文对照：https://npmcn.com/package/%40brillout/release-me/?lang=original
项目主页：https://github.com/brillout/release-me#readme
源码仓库：https://github.com/brillout/release-me

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：41.5 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2022-09-02T12:49:37.879Z
- 最新版本发布：2026-10-04T18:59:14.834Z
- 近 30 天下载量：37714（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 11 个）

## 中文简介

发布您的 npm 软件包 .

## 安装

```sh
npm install @brillout/release-me
```

也可以使用：`pnpm add @brillout/release-me`、`yarn add @brillout/release-me`、`bun add @brillout/release-me`

## README

# `@brillout/release-me`

发布您的 npm 软件包 .

用于:

-   维琪
-   电报
-   制作的包裹 [`brillout`](https://github.com/brillout)
-   制作的包裹 [`magne4000`](https://github.com/magne4000)

[特征](https://npmcn.com/package/%40brillout/release-me/#readme-features)  
[开始吧](https://npmcn.com/package/%40brillout/release-me/#readme-get-started)  
[使用量](https://npmcn.com/package/%40brillout/release-me/#readme-usage)  
[单曲](https://npmcn.com/package/%40brillout/release-me/#readme-monorepo)

> \[尖叫声\] 别用这个:它只是给维克的团队和朋友用的. 这么说吧,你可以随意把这个项目叉开.

  

## 特征

-   生成 `CHANGELOG.md`。 。 。 .
-   莫诺雷波支持.
-   生成 Git 释放标记 .
-   释前供养. (例如 [`0.4.177-commit-ff3d6cd`](https://www.npmjs.com/package/vike/v/0.4.177-commit-ff3d6cd). ) (中文(简体) )
-   发布前要求确认,并显示更改的预览 `package.json` 财务报告和审定财务报表 `CHANGELOG.md`,允许您在发布前重复检查.

  

## 开始吧

### 安装

运行 `$ pnpm -D @brillout/release-me` 并确保您有以下内容:

```json5
// package.json
{
  "name": "my-package",
  "version": "0.1.2",
  "scripts": {
    "build": "echo 'Some build step (release-me runs the build script before releasing)'"
  },
  "devDependencies": {
    "@brillout/release-me": "^0.4.0"
  }
}
```

就是这样,你可以使用 `pnpm exec release-me patch` 以发布新的补丁版本.

我们建议增加以下文字:

```diff
 // package.json
 {
   "name": "my-package",
   "version": "0.1.2",
   "scripts": {
     "build": "echo 'Some build step (release-me runs the build script before releasing)'"
+    "release": "release-me patch",
+    "release:minor": "release-me minor",
+    "release:major": "release-me major",
+    "release:commit": "release-me commit"
   },
   "devDependencies": {
     "@brillout/release-me": "^0.4.0"
   }
 }
```

这是向任何发现你项目的人 传达新版本的方便方式.

安装示例 : [`8ff59fe`](https://github.com/brillout/test-e2e/commit/8ff59fea41c4956aeaf18b048a34faeaf98a47c5)。 。 。 .

A 类 `CHANGELOG.md` 文件将自动生成和更新,参见下一节.

### 常规武器委员会

当然 `CHANGELOG.md` 世代确保跟随 [常规武器委员会](https://www.conventionalcommits.org/)。 。 。 .

换句话说:

-   `fix:` qqbug 修正或一些抛光(例如改进后的错误消息).
-   `feat:` qq新功能,即新功能.

用于突破更改的附加 `BREAKING CHANGE:` 执行信息:

```
fix: make someFunction() take an argument object

BREAKING CHANGE: Replace `someFunction(someArg)` with `someFunction({ someArg })`.
```

> \[注\] 为了尊重 [铸造](https://semver.org/) 公约,不要 `pnpm exec release-me patch` 不过 `pnpm exec release-me major` 相反(或 `pnpm exec release-me minor` 如果你的软件包的版本是 `0.y.z`) (中文(简体) ).

  

## 使用量

发布新的补丁/小于/主要版本 :

```shell
pnpm exec release-me patch
```

```shell
pnpm exec release-me minor
```

```shell
pnpm exec release-me major
```

> \[注\] 我们建议界定 `package.json#scripts` (见上文)和使用 `$ pnpm run` 改为 `$ pnpm exec`。 。 。 .

发布特定版本 :

```shell
pnpm exec release-me v0.1.2
```

您也可发布预发文件,例如 [`0.4.177-commit-ff3d6cd`](https://www.npmjs.com/package/vike/v/0.4.177-commit-ff3d6cd)数字 :

```shell
pnpm exec release-me commit
```

  

## 单曲

当从单体中释放一个包时,在单体中添加以下承诺: `CHANGELOG.md` 软件包:

-   如果犯罪具有范围(例如:. `fix(some-package): some commit`),只有在瞄准镜与包件相匹配时才将其包括在内 `package.json#name`。 。 。 .
-   如果犯罪没有范围(例如:. `fix: some commit`),它只有在修改了包根目录中的文件(即包的目录)时才被包含在内 `package.json` (见a/cn.9/wg.iii/wp.96,第2段).

> \[注\] 默认, `CHANGELOG.md` 生活在软件包的目录中( e)`$packageRootDir/CHANGELOG.md`),除非存储器只有一个软件包和 `CHANGELOG.md` 已经存在于 `$monorepoRootDir/CHANGELOG.md`。 。 。 .

## 常见问题

### @brillout/release-me 是什么？

发布您的 npm 软件包 \.

### 如何安装 @brillout/release-me？

在项目目录运行 npm install @brillout/release-me，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 release-me，可以用 npx release-me 直接运行。

### @brillout/release-me 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/brillout\_\_release-me 是否存在。

### @brillout/release-me 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @brillout/release-me 可以商用吗？

@brillout/release-me 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @brillout/release-me 的下载量有多少？

根据 npm 官方下载统计，@brillout/release-me 在 2026/10/09 – 2026/11/07 这 30 天内被下载 37,714 次，日均约 1,257 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @brillout/release-me 还在维护吗？

最新版本 0\.4\.19 发布于 2026/10/05（1 个月前）；至今共发布 61 个版本，其中过去 12 个月发布了 11 个；首次发布于 2022/09/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。