Skip to content

Commit 906a1cf

Browse files
JusterZhuclaude
andcommitted
docs: reference SemVer in advanced cookbook version strategy
- Add Semantic Versioning (semver.org) reference in section 4.1 - Map GeneralUpdate 4-part versioning to SemVer MAJOR.MINOR.PATCH - Use language-appropriate URLs: semver.org/lang/zh-CN/ for Chinese, semver.org/ for English - Explain Revision segment as .NET System.Version extension Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent fd6ec96 commit 906a1cf

3 files changed

Lines changed: 36 additions & 18 deletions

File tree

website/docs/quickstart/Advanced cookbook.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,17 +202,23 @@ jobs:
202202

203203
### 4.1 版本号规范
204204

205-
GeneralUpdate 使用 `Major.Minor.Build.Revision` 四段式版本号:
205+
GeneralUpdate 遵循[语义化版本](https://semver.org/lang/zh-CN/)(SemVer)规范的核心原则。在 SemVer `MAJOR.MINOR.PATCH` 的基础上,为兼容 .NET `System.Version`,扩展了第四个 `Revision` 段,形成 `Major.Minor.Build.Revision` 四段式版本号:
206206

207207
```text
208208
2.0.0.0
209-
│ │ │ └── Revision(修订号)
210-
│ │ └──── Build(构建号)
211-
│ └────── Minor(次版本号)
212-
└──────── Major(主版本号)
209+
│ │ │ └── Revision(修订号)— 对应 .NET 第四段,非 SemVer 标准
210+
│ │ └──── Build(构建号) — 对应 SemVer PATCH
211+
│ └────── Minor(次版本号) — 对应 SemVer MINOR
212+
└──────── Major(主版本号) — 对应 SemVer MAJOR
213213
```
214214

215-
Server 使用 `new Version(string)` 进行比较,因此请保持数字格式。
215+
版本号规则:
216+
- **Major**(主版本号):不兼容的 API 修改时递增
217+
- **Minor**(次版本号):向下兼容的功能新增时递增
218+
- **Build**(构建号/补丁号):向下兼容的问题修正时递增
219+
- **Revision**(修订号):内部修订,通常为 `0`,仅在 .NET 程序集版本中区分
220+
221+
Server 使用 `new Version(string)` 进行比较,因此请保持纯数字格式。更多细节参见 [语义化版本 2.0.0](https://semver.org/lang/zh-CN/)。
216222

217223
### 4.2 更新模式
218224

website/i18n/en/docusaurus-plugin-content-docs/current/quickstart/Advanced cookbook.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,17 +202,23 @@ Confirm before every release:
202202

203203
### 4.1 Version number conventions
204204

205-
GeneralUpdate uses `Major.Minor.Build.Revision` four-part versioning:
205+
GeneralUpdate follows [Semantic Versioning](https://semver.org/) (SemVer) core principles. On top of SemVer `MAJOR.MINOR.PATCH`, a fourth `Revision` segment is added for .NET `System.Version` compatibility, forming the `Major.Minor.Build.Revision` four-part scheme:
206206

207207
```text
208208
2.0.0.0
209-
│ │ │ └── Revision
210-
│ │ └──── Build
211-
│ └────── Minor
212-
└──────── Major
209+
│ │ │ └── Revision — .NET 4th segment, not in SemVer standard
210+
│ │ └──── Build — maps to SemVer PATCH
211+
│ └────── Minor — maps to SemVer MINOR
212+
└──────── Major — maps to SemVer MAJOR
213213
```
214214

215-
Server compares with `new Version(string)` — keep the numeric format.
215+
Version rules:
216+
- **Major**: incremented for incompatible API changes
217+
- **Minor**: incremented for backwards-compatible new functionality
218+
- **Build** (patch): incremented for backwards-compatible bug fixes
219+
- **Revision**: internal revision, typically `0`; only distinguished in .NET assembly versions
220+
221+
Server compares with `new Version(string)` — keep the numeric format. See [Semantic Versioning 2.0.0](https://semver.org/) for details.
216222

217223
### 4.2 Update modes
218224

website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/quickstart/Advanced cookbook.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -202,17 +202,23 @@ jobs:
202202

203203
### 4.1 版本号规范
204204

205-
GeneralUpdate 使用 `Major.Minor.Build.Revision` 四段式版本号:
205+
GeneralUpdate 遵循[语义化版本](https://semver.org/lang/zh-CN/)(SemVer)规范的核心原则。在 SemVer `MAJOR.MINOR.PATCH` 的基础上,为兼容 .NET `System.Version`,扩展了第四个 `Revision` 段,形成 `Major.Minor.Build.Revision` 四段式版本号:
206206

207207
```text
208208
2.0.0.0
209-
│ │ │ └── Revision(修订号)
210-
│ │ └──── Build(构建号)
211-
│ └────── Minor(次版本号)
212-
└──────── Major(主版本号)
209+
│ │ │ └── Revision(修订号)— 对应 .NET 第四段,非 SemVer 标准
210+
│ │ └──── Build(构建号) — 对应 SemVer PATCH
211+
│ └────── Minor(次版本号) — 对应 SemVer MINOR
212+
└──────── Major(主版本号) — 对应 SemVer MAJOR
213213
```
214214

215-
Server 使用 `new Version(string)` 进行比较,因此请保持数字格式。
215+
版本号规则:
216+
- **Major**(主版本号):不兼容的 API 修改时递增
217+
- **Minor**(次版本号):向下兼容的功能新增时递增
218+
- **Build**(构建号/补丁号):向下兼容的问题修正时递增
219+
- **Revision**(修订号):内部修订,通常为 `0`,仅在 .NET 程序集版本中区分
220+
221+
Server 使用 `new Version(string)` 进行比较,因此请保持纯数字格式。更多细节参见 [语义化版本 2.0.0](https://semver.org/lang/zh-CN/)。
216222

217223
### 4.2 更新模式
218224

0 commit comments

Comments
 (0)