From cfe2445fe4ced4936c38fd5a45fe0033002b8d6a Mon Sep 17 00:00:00 2001 From: Shiroha7z Date: Mon, 28 Sep 2026 15:58:12 +0800 Subject: [PATCH] docs: pin stable installation during pnpm release delay --- .changeset/stable-install-guidance.md | 6 ++++++ README.en.md | 6 ++++-- README.md | 4 +++- docs/en/guide/backup-upgrade.mdx | 4 +++- docs/en/guide/index.mdx | 4 +++- docs/zh/dev/style-sample.mdx | 2 +- docs/zh/guide/backup-upgrade.mdx | 4 +++- docs/zh/guide/index.mdx | 4 ++-- packages/cli/README.md | 12 ++++++------ packages/meta/README.md | 9 ++++----- 10 files changed, 35 insertions(+), 20 deletions(-) create mode 100644 .changeset/stable-install-guidance.md diff --git a/.changeset/stable-install-guidance.md b/.changeset/stable-install-guidance.md new file mode 100644 index 00000000..4e879378 --- /dev/null +++ b/.changeset/stable-install-guidance.md @@ -0,0 +1,6 @@ +--- +"@sfmc-bds/cli": patch +"@sfmc-bds/sfmc": patch +--- + +修正正式版包内安装说明，并明确 pnpm 新发布版本的默认等待期和精确版本安装方式。 diff --git a/README.en.md b/README.en.md index 5f6c6ea2..cf129837 100644 --- a/README.en.md +++ b/README.en.md @@ -84,7 +84,7 @@ Ensure **Node.js ≥ 22.13.0** is installed (required for native `node:sqlite` s ```bash # 1. Install SFMC CLI globally -pnpm add -g @sfmc-bds/sfmc@beta +pnpm add -g @sfmc-bds/sfmc@0.2.2 # 2. Create and enter your server workspace mkdir my-bedrock-server && cd my-bedrock-server @@ -96,9 +96,11 @@ sfmc sfmc> start -all # 5. Search and install gameplay modules from the official index -sfmc> mod install economy land teleport +sfmc> mod install afk ``` +pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. To install on release day, check `pnpm view @sfmc-bds/sfmc version` and pin that exact version as above. + ### Track B: Module Authors (Build in 5 Minutes) You don't need to clone this monorepo! Scaffold your standalone module repository directly: diff --git a/README.md b/README.md index 93bd7e55..a384fd2e 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ SFMC 希望通过模块化架构补充基岩版的原生开发体验。 node -v # 安装 SFMC CLI 正式版 -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 # 创建服务器目录 mkdir my-server && cd my-server @@ -50,6 +50,8 @@ mkdir my-server && cd my-server sfmc ``` +pnpm v11 起默认会等待新版本发布满 24 小时。发布当天若省略版本号，可能装到上一正式版；可用 `pnpm view @sfmc-bds/sfmc version` 查看当前 `latest`，再指定该精确版本安装。 + 开发者可以直接克隆本 monorepo，详细内容请查看 [入门指南](./docs/zh/guide/index.mdx)。 diff --git a/docs/en/guide/backup-upgrade.mdx b/docs/en/guide/backup-upgrade.mdx index c4ef8281..4c2f2e06 100644 --- a/docs/en/guide/backup-upgrade.mdx +++ b/docs/en/guide/backup-upgrade.mdx @@ -34,7 +34,7 @@ Do not copy `.db` files while db-server is running. ```bash -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 ``` @@ -48,6 +48,8 @@ pnpm install && pnpm run build +pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. For a release-day upgrade, check `pnpm view @sfmc-bds/sfmc version` and install that exact version. + Confirm `SFMC_ROOT` and the CLI version before changing the instance. Upgrading the CLI does not replace installed modules or the deployed behavior pack. In a maintenance window, install the intended module versions, then build and deploy before starting BDS: ```bash diff --git a/docs/en/guide/index.mdx b/docs/en/guide/index.mdx index 10d99dc0..3beb3513 100644 --- a/docs/en/guide/index.mdx +++ b/docs/en/guide/index.mdx @@ -35,7 +35,7 @@ flowchart LR ```bash -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 mkdir my-server && cd my-server sfmc ``` @@ -53,6 +53,8 @@ sfmc +pnpm v11+ waits 24 hours by default before selecting a newly published version from an unversioned package name. On release day, use `pnpm view @sfmc-bds/sfmc version` and install that exact version as shown above. Use `@beta` only to opt into prereleases. + :::tip Note This installs the stable `latest` release. Add `@beta` only when you want a prerelease. Data defaults to the current directory; set `SFMC_ROOT` to use another root. diff --git a/docs/zh/dev/style-sample.mdx b/docs/zh/dev/style-sample.mdx index bdd17524..4aaca655 100644 --- a/docs/zh/dev/style-sample.mdx +++ b/docs/zh/dev/style-sample.mdx @@ -37,7 +37,7 @@ flowchart LR ```bash -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 mkdir my-server && cd my-server sfmc ``` diff --git a/docs/zh/guide/backup-upgrade.mdx b/docs/zh/guide/backup-upgrade.mdx index ca07fae5..40575b2a 100644 --- a/docs/zh/guide/backup-upgrade.mdx +++ b/docs/zh/guide/backup-upgrade.mdx @@ -101,12 +101,14 @@ SFMC 平台的各层组件相互解耦，可按需分别升级： ```bash # 获取最新版官方 CLI -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 # 验证更新后版本 sfmc --version ``` +pnpm v11 起默认要求新版本发布满 24 小时才参与无版本号解析。升级当天请先运行 `pnpm view @sfmc-bds/sfmc version`，然后安装该精确版本。 + diff --git a/docs/zh/guide/index.mdx b/docs/zh/guide/index.mdx index 3148eb38..4a9fefcf 100644 --- a/docs/zh/guide/index.mdx +++ b/docs/zh/guide/index.mdx @@ -50,11 +50,11 @@ SFMC 提供了全局编排 CLI 工具，可实现从 BDS 自动下载配置到 ### 步骤 1：全局安装 SFMC CLI ```bash -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 ``` :::tip 提示 -默认安装正式版。若要试用预发布版本，再显式添加 `@beta`。如需在特定文件夹持久化数据，可通过配置 `SFMC_ROOT` 环境变量指定自定义工作目录。 +pnpm v11 起默认要求新版本发布满 24 小时才参与无版本号解析。发布当天安装请指定上面的精确版本；可先用 `pnpm view @sfmc-bds/sfmc version` 查询当前 `latest`。只有试用预发布版本时才使用 `@beta`。如需在特定文件夹持久化数据，可通过配置 `SFMC_ROOT` 环境变量指定自定义工作目录。 ::: ### 步骤 2：创建服务器工作区并启动向导 diff --git a/packages/cli/README.md b/packages/cli/README.md index bb25b5f1..b4c9d67a 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -5,23 +5,23 @@ SFMC 管理 CLI：REPL、服务启停、模块安装、行为包 build/deploy。 ## 安装 ```bash -pnpm add -g @sfmc-bds/cli -pnpm dlx @sfmc-bds/cli status +pnpm add -g @sfmc-bds/cli@0.2.2 +pnpm dlx @sfmc-bds/cli@0.2.2 status ``` 服主推荐： ```bash -pnpm add -g @sfmc-bds/sfmc +pnpm add -g @sfmc-bds/sfmc@0.2.2 ``` -仅 CLI（不含后端服务）可用 `pnpm add -g @sfmc-bds/cli`，完整平台请装聚合包。 +仅 CLI（不含后端服务）可安装 `@sfmc-bds/cli`，完整平台请装聚合包。pnpm v11 起对新发布版本默认有 24 小时等待期；发布当天安装请指定精确版本。 ## 依赖 -- `@sfmc-bds/sdk` ^0.1.0 +- `@sfmc-bds/sdk` 0.2.0 - Node.js >= 22.13 ## 仓库 - + diff --git a/packages/meta/README.md b/packages/meta/README.md index 48f12c2f..3492dac3 100644 --- a/packages/meta/README.md +++ b/packages/meta/README.md @@ -6,7 +6,7 @@ SFMC 聚合包： ## 安装 ```bash -pnpm add -g @sfmc-bds/sfmc@beta +pnpm add -g @sfmc-bds/sfmc@0.2.2 ``` 或在项目目录本地安装： @@ -14,11 +14,11 @@ pnpm add -g @sfmc-bds/sfmc@beta ```bash mkdir my-server && cd my-server pnpm init -pnpm add @sfmc-bds/sfmc@beta +pnpm add @sfmc-bds/sfmc@0.2.2 pnpm exec sfmc ``` -> 当前仅开放 **beta** 通道。稳定 `latest` 未开放前请始终带 `@beta`。 +正式版已发布到 npm `latest`。[pnpm v11 起默认要求新版本发布满 24 小时](https://pnpm.io/settings/dependency-resolution#minimumreleaseage)才参与无版本号解析；如需在发布当天安装，请像上面一样指定精确版本。可用 `pnpm view @sfmc-bds/sfmc version` 查询当前 `latest`；试用预发布版本时才使用 `@beta`。 ## 首次使用 @@ -45,7 +45,6 @@ sfmc > start -all | `@sfmc-bds/db-server` | SQLite HTTP 后端 | | `@sfmc-bds/qq-bridge` | QQ 互通桥接服务 | | `@sfmc-bds/bds-tools` | BDS 更新与行为包装配 | -| `@sfmc-bds/cli` | CLI + `fetch-module`（`mod install`） | | `@sfmc-bds/sdk` | 共享 SDK | ## 环境变量 @@ -58,4 +57,4 @@ sfmc > start -all ## 仓库 - +