Skip to content

Commit a362d06

Browse files
committed
refactor: replace latest tag with stable release tag
Update documentation and config to enforce stable release usage instead of luminous 'latest' tags, clarifying terminology and reducing instability risks.
1 parent 9409572 commit a362d06

5 files changed

Lines changed: 42 additions & 39 deletions

File tree

docs/guides/gettingStarted/cluster.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,17 @@ A 和 B 两台机器以及组件集群内网互通,且A、B两台机器都有
4040

4141
### 1. 克隆仓库
4242

43-
在两台机器(A 和 B)上分别执行以下命令以克隆 OpenIMServer 仓库:
43+
在两台机器(A 和 B)上分别执行以下命令以克隆 OpenIMServer 仓库,并切到 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag**
4444

4545
```bash
4646
git clone https://github.com/openimsdk/open-im-server
4747
cd open-im-server
4848
git fetch --tags
49-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
50-
git checkout "$LATEST_TAG"
49+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/open-im-server/releases/latest)")
50+
git checkout "$LATEST_STABLE_TAG"
5151
```
5252

53-
> 建议两台机器使用同一个 tag(默认 latest tag)。如需固定版本(例如 `v3.8.3-patch.12`),请在两台机器都执行 `git checkout v3.8.3-patch.12`
53+
> 这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。建议两台机器使用同一个正式版 tag;如需固定版本(例如 `v3.8.3-patch.12`),请在两台机器都执行 `git checkout v3.8.3-patch.12`
5454
5555
### 2. 配置修改
5656

docs/guides/gettingStarted/dockerCompose.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ sidebar_position: 2
99
## 2. 部署 OpenIMServer
1010
### 2.1 仓库克隆 🗂️
1111

12-
建议使用 **latest tag**避免直接跟随未发布变更
12+
建议使用 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag**不要直接按 tag 名字排序,也不要使用 alpha/rc 等预发布版本
1313

1414
```bash
1515
git clone https://github.com/openimsdk/openim-docker && cd openim-docker
1616
git fetch --tags
17-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
18-
git checkout "$LATEST_TAG"
19-
echo "using openim-docker tag: $LATEST_TAG"
17+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/openim-docker/releases/latest)")
18+
git checkout "$LATEST_STABLE_TAG"
19+
echo "using openim-docker stable release tag: $LATEST_STABLE_TAG"
2020
```
2121

22-
> 如需复现指定版本(例如 `v3.8.3-patch.12`),将 `git checkout "$LATEST_TAG"` 替换为 `git checkout v3.8.3-patch.12`
22+
> 这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本
2323
2424
### 2.2 配置修改 🔧
2525

docs/guides/gettingStarted/faq.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 10
55

66
## 一、如何升级
77

8-
在同一大版本内,不同小版本之间的数据通常兼容。建议优先升级到目标仓库的 **latest tag**;如需固定版本(例如 `v3.8.3-patch.12`),请显式 checkout 对应 tag。
8+
在同一大版本内,不同小版本之间的数据通常兼容。建议优先升级到目标仓库 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag**;如需固定版本(例如 `v3.8.3-patch.12`),请显式 checkout 对应 tag。
99

1010
### Docker 部署
1111

@@ -14,12 +14,12 @@ sidebar_position: 10
1414
cd openim-docker
1515
```
1616

17-
2. **拉取最新 tag 并切换:**
17+
2. **拉取最新正式版 release tag 并切换:**
1818
```bash
1919
git fetch --tags
20-
TARGET_TAG=$(git tag --sort=-v:refname | head -n 1)
20+
TARGET_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/openim-docker/releases/latest)")
2121
git checkout "$TARGET_TAG"
22-
echo "upgrade openim-docker to tag: $TARGET_TAG"
22+
echo "upgrade openim-docker to stable release tag: $TARGET_TAG"
2323
```
2424

2525
3. **检查 `.env` 中镜像 tag 与当前仓库版本一致(必要时按发布说明手动调整)。**
@@ -48,10 +48,10 @@ sidebar_position: 10
4848
mage stop
4949
```
5050

51-
3. **切换到最新 tag(或指定 tag)并更新代码:**
51+
3. **切换到最新正式版 release tag(或指定 tag)并更新代码:**
5252
```bash
5353
git fetch --tags
54-
TARGET_TAG=$(git tag --sort=-v:refname | head -n 1)
54+
TARGET_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/open-im-server/releases/latest)")
5555
git checkout "$TARGET_TAG"
5656
```
5757

@@ -63,6 +63,8 @@ sidebar_position: 10
6363

6464
5. **如果部署了 ChatServer,也建议同步升级到对应 tag 后再重启 Chat 服务。**
6565

66+
> 说明:这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。
67+
6668

6769
---
6870
## 二、 如何迁移数据

docs/guides/gettingStarted/imSourceCodeDeployment.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ OpenIMServer 与外部组件部署在同一台机器上,部分组件可按需
1313

1414
## 二、获取 OpenIMServer 并部署依赖组件
1515

16-
建议通过仓库拉取并切到 **latest tag**(而不是直接跟随分支)
16+
建议通过仓库拉取并切到 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag**
1717

1818
```bash
1919
git clone https://github.com/openimsdk/open-im-server && cd open-im-server
2020
git fetch --tags
21-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
22-
git checkout "$LATEST_TAG"
23-
echo "using open-im-server tag: $LATEST_TAG"
21+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/open-im-server/releases/latest)")
22+
git checkout "$LATEST_STABLE_TAG"
23+
echo "using open-im-server stable release tag: $LATEST_STABLE_TAG"
2424
```
2525

26-
> 如需复现指定版本(例如 `v3.8.3-patch.12`),将 `git checkout "$LATEST_TAG"` 替换为 `git checkout v3.8.3-patch.12`
26+
> 这里的 latest 指 GitHub Releases 页面绿色 Latest 的**正式发布版**,不包含 alpha/beta/rc 等预发布版本。当前该仓库会把 `v3.8.3-patch.12` 识别为最新正式版,而不会误选 `v3.8.4-alpha.1` 这类预发布版本
2727
2828
> 注意:后续所有命令都在 OpenIMServer 项目根目录执行。
2929
@@ -107,17 +107,17 @@ mage
107107

108108
> 如果已有自有账号系统,可不部署 ChatServer。
109109
110-
同样建议拉取后切到 **latest tag**
110+
同样建议拉取后切到 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag**
111111

112112
```bash
113113
git clone https://github.com/openimsdk/chat && cd chat
114114
git fetch --tags
115-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
116-
git checkout "$LATEST_TAG"
117-
echo "using chat tag: $LATEST_TAG"
115+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/chat/releases/latest)")
116+
git checkout "$LATEST_STABLE_TAG"
117+
echo "using chat stable release tag: $LATEST_STABLE_TAG"
118118
```
119119

120-
> 如需复现指定版本(例如 `v3.8.3-patch.12` 对应联调版本),按实际发布说明改为固定 tag。
120+
> 如需复现指定版本,按实际发布说明改为固定 tag;若服务端联调需要固定到 `v3.8.3-patch.12` 对应版本,也请同时固定 ChatServer 的对应正式版 tag。
121121
122122
## 五、部署 ChatServer
123123

docs/guides/gettingStarted/internalDeployment.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ sidebar_position: 4
88

99
## 版本策略(重要)
1010

11-
- 默认建议:在联网机器上拉取仓库后,切换到 **latest tag** 再做离线打包。
12-
- 如需固定版本(例如 `v3.8.3-patch.12`):将 `git checkout "$LATEST_TAG"` 替换为 `git checkout v3.8.3-patch.12`
11+
- 默认建议:在联网机器上拉取仓库后,切换到 GitHub Releases 页面绿色 **Latest** 对应的**最新正式发布 tag** 再做离线打包。
12+
- 这里的 latest 指**正式发布版**,不包含 alpha/beta/rc 等预发布版本。
13+
- 如需固定版本(例如 `v3.8.3-patch.12`):直接执行 `git checkout v3.8.3-patch.12`
1314
- 强烈建议:OpenIMServer、ChatServer、openim-docker 使用同一批次发布版本,避免跨版本组合。
1415

1516
### **Docker部署**
1617

17-
1. 使用一台连接到互联网的机器,克隆仓库并切换到 latest tag:
18+
1. 使用一台连接到互联网的机器,克隆仓库并切换到最新正式发布 tag:
1819

1920
```sh
2021
git clone https://github.com/openimsdk/openim-docker && cd openim-docker
2122
git fetch --tags
22-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
23-
git checkout "$LATEST_TAG"
24-
echo "using openim-docker tag: $LATEST_TAG"
23+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/openim-docker/releases/latest)")
24+
git checkout "$LATEST_STABLE_TAG"
25+
echo "using openim-docker stable release tag: $LATEST_STABLE_TAG"
2526
```
2627

2728
2. 运行 `docker compose up -d` 拉取镜像并生成本地镜像清单。
@@ -61,24 +62,24 @@ sidebar_position: 4
6162

6263
### **源码部署**
6364

64-
1. 使用一台连接到互联网的机器,克隆 OpenIMServer 并切换到 latest tag:
65+
1. 使用一台连接到互联网的机器,克隆 OpenIMServer 并切换到最新正式发布 tag:
6566

6667
```sh
6768
git clone https://github.com/openimsdk/open-im-server && cd open-im-server
6869
git fetch --tags
69-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
70-
git checkout "$LATEST_TAG"
71-
echo "using open-im-server tag: $LATEST_TAG"
70+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/open-im-server/releases/latest)")
71+
git checkout "$LATEST_STABLE_TAG"
72+
echo "using open-im-server stable release tag: $LATEST_STABLE_TAG"
7273
```
7374

74-
2. 克隆 ChatServer 并切换到 latest tag:
75+
2. 克隆 ChatServer 并切换到最新正式发布 tag:
7576

7677
```bash
7778
git clone https://github.com/openimsdk/chat && cd chat
7879
git fetch --tags
79-
LATEST_TAG=$(git tag --sort=-v:refname | head -n 1)
80-
git checkout "$LATEST_TAG"
81-
echo "using chat tag: $LATEST_TAG"
80+
LATEST_STABLE_TAG=$(basename "$(curl -fsSLI -o /dev/null -w '%{url_effective}' https://github.com/openimsdk/chat/releases/latest)")
81+
git checkout "$LATEST_STABLE_TAG"
82+
echo "using chat stable release tag: $LATEST_STABLE_TAG"
8283
```
8384

8485
3. 参考 [docker部署](#docker部署) 步骤保存依赖组件镜像(源码部署场景不需要服务端业务镜像)。

0 commit comments

Comments
 (0)