Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 59 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,82 @@ $ yarn install

## OTel 版本更新

当 Alauda Build of OpenTelemetry 发布新版本时,使用 `hack/update-otel-version.sh` 批量更新 `./docs/en/` 下所有 `.mdx` 文档中出现的旧版本号。
### OTel 版本号更新

### 用法
当 Alauda Build of OpenTelemetry 发布新版本时,使用 `hack/update-otel-version.sh` 批量更新 `./docs/en/` 下所有 `.mdx` 文档中出现的旧版本号。脚本同时适用于 Operator 版本与 Collector 版本。

#### 用法

```bash
./hack/update-otel-version.sh <旧版本> <新版本>
./hack/update-otel-version.sh [选项] <旧版本> <新版本>
```

版本号格式为 `X.Y.Z-rN`,例如 `0.146.0-r0`。
选项:

| 选项 | 说明 |
| ----------------- | -------------------------------------------------- |
| `-n`, `--dry-run` | 只列出将要发生的替换(含文件名与行号),不写入文件 |
| `-h`, `--help` | 显示帮助 |

版本号格式为 `X.Y.Z`,可带后缀,例如 `0.158.0`、`0.147.0-r0`、`0.156.0-rc.2`。

脚本按完整版本号做边界匹配,因此 Operator 版本与 Collector 版本可以独立更新,互不干扰:用 `0.158.0` 替换时不会命中 `0.158.0-r1`,用 `0.156.0` 替换时也不会命中 `0.156.0-rc.2`。

#### 操作步骤

1. 确认新的 Operator 版本(例如 `0.156.0-rc.2`)与 Collector 版本(例如 `0.158.0`)。
2. 在仓库根目录先预览要改哪些地方:

### 操作步骤
```bash
./hack/update-otel-version.sh --dry-run 0.147.0-r0 0.156.0-rc.2
```

1. 确认新版本号(例如 `0.147.0-r0`)。
2. 在仓库根目录执行脚本:
3. 确认无误后分别执行 Operator 与 Collector 版本的替换:

```bash
./hack/update-otel-version.sh 0.146.0-r0 0.147.0-r0
# Operator 版本
./hack/update-otel-version.sh 0.147.0-r0 0.156.0-rc.2
# Collector 版本
./hack/update-otel-version.sh 0.147.0 0.158.0
```

脚本会自动查找 `./docs/en/` 下所有包含旧版本号的 `.mdx` 文件,并将其中的旧版本号全部替换为新版本号;运行结束后会输出被修改的文件列表。

3. 使用 `git diff` 检查改动是否符合预期:
4. 使用 `git diff` 检查改动是否符合预期:

```bash
git diff docs/en/
```

4. 本地运行 `yarn dev` 预览相关页面,确认渲染无异常。
5. 确认无误后提交改动并发起 PR。
5. 本地运行 `yarn dev` 预览相关页面,确认渲染无异常。
6. 确认无误后提交改动并发起 PR。

> 提示:若想新增其它需要随版本一起更新的文件类型或目录,可直接编辑 `hack/update-otel-version.sh` 中的 `grep -r --include='*.mdx'` 与 `DOCS_DIR` 配置。

### Java 自动插桩镜像版本更新

使用 `hack/update-java-autoinstrumentation-version.sh` 批量更新 `./docs/en/` 下所有 `.mdx` 文档中的 `autoinstrumentation-java` 镜像版本。脚本支持官方 GHCR 镜像以及自建或镜像仓库地址。

```bash
./hack/update-java-autoinstrumentation-version.sh <旧版本> <新版本>
```

例如,将镜像版本从 `2.26.1` 更新为 `2.29.0`:

```bash
./hack/update-java-autoinstrumentation-version.sh 2.26.1 2.29.0
```

### OTel 新版本内容同步更新

让 AI 读取当前版本到新版本更新的内容:

- https://github.com/open-telemetry/opentelemetry-operator/releases
- https://github.com/open-telemetry/opentelemetry-collector/releases
- https://github.com/open-telemetry/opentelemetry-collector-contrib/releases

然后分析当前文档是否有需要同步更新的部分,review 后执行更新。

### sites.yaml 更新

更新 [sites.yaml](./sites.yaml) 中的最新外链站点。
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Below is the life cycle schedule for released versions of the `Alauda Build of O
| Version | Release Date | End of Support |
| -------- | ------------- | --------------- |
| v2.0.z | 2026-04-21 | 2027-10-21 |
| v2.1.z | 2026-08-21 | 2028-02-21 |

## Release Policy

Expand Down
34 changes: 0 additions & 34 deletions docs/en/about/release-notes/v2-0-0.mdx

This file was deleted.

Loading