Skip to content

docs: use ticdc-version variable in TiCDC examples (#21911) - #21917

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-21911-to-master
Sep 4, 2026
Merged

docs: use ticdc-version variable in TiCDC examples (#21911)#21917
ti-chi-bot[bot] merged 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-21911-to-master

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Sep 3, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21911

What is changed, added or deleted? (Required)

  • Add ticdc-version to variables.json
  • Replace hard-coded TiCDC example versions in ticdc/ticdc-architecture.md with v{{{ .ticdc-version }}}
  • Keep the release-threshold statements (v8.5.4 / v8.5.4-release.1) unchanged and update only example snippets and example commands

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • 文档

    • 更新 TiCDC 部署示例,支持通过模板变量统一指定 TiCDC 版本,涵盖新集群部署、离线包下载及现有集群升级场景。
  • 配置

    • 新增 TiCDC 版本配置项,默认使用 8.5.8。

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot added area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Sep 3, 2026
@ti-chi-bot

Copy link
Copy Markdown
Member Author

@doc-claw-bot This PR has conflicts, I have hold it.
Please resolve them or ask others to resolve them, then comment /unhold to remove the hold label.

@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: 08a615d9-b42a-4668-863c-3ff92d23b095

📥 Commits

Reviewing files that changed from the base of the PR and between fedc220 and 8f41226.

📒 Files selected for processing (1)
  • variables.json
💤 Files with no reviewable changes (1)
  • variables.json

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

TiCDC 部署示例改用 ticdc-version 模板变量。variables.json 新增该变量,值为 8.5.8

Changes

TiCDC 版本模板化

Layer / File(s) Summary
版本变量配置
variables.json
新增值为 8.5.8ticdc-version 属性。
部署示例版本替换
ticdc/ticdc-architecture.md
TiDB Operator 和 TiUP 部署示例使用 ticdc-version 模板变量,并同步更新离线包链接与补丁文件名。

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🟠 High · up to 8f412

This change templates TiCDC versions in deployment documentation, but unresolved conflict markers in the version configuration make the configuration invalid and can leave published examples with unresolved placeholders. Resolve the conflict before merging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了主要变更:在 TiCDC 示例中使用 ticdc-version 变量。标题简洁、明确,并包含相关 PR 编号。
Description check ✅ Passed 描述包含变更内容、适用版本、相关链接、AI 参与情况和变更类型检查项。描述与文件变更一致。版本复选框与模板存在少量差异,但已明确选择 master 和 v8.5,不影响主要信息完整性。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: c972816d-21fc-4384-9766-ab0d908aa44a

📥 Commits

Reviewing files that changed from the base of the PR and between abe71f2 and fedc220.

📒 Files selected for processing (2)
  • ticdc/ticdc-architecture.md
  • variables.json

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread variables.json Outdated
Comment on lines +3 to +8
<<<<<<< HEAD
"tidb-version": "v8.5.0",
=======
"tidb-version": "8.5.8",
"ticdc-version": "8.5.8",
>>>>>>> 34087e135a (docs: use ticdc-version variable in TiCDC examples (#21911))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🔴 Critical | ⚡ Quick win

删除未解析的合并冲突标记。

<<<<<<< HEAD=======>>>>>>> ... 使 variables.json 不是合法 JSON。load_variables() 会捕获解析异常并返回空字典,因此 ticdc-version 等模板变量不会被替换,文档产物会保留字面量占位符。请保留 8.5.8 的两个版本值,并删除冲突标记。

建议替换冲突片段
-<<<<<<< HEAD
-  "tidb-version": "v8.5.0",
-=======
-  "tidb-version": "8.5.8",
-  "ticdc-version": "8.5.8",
->>>>>>> 34087e135a (docs: use ticdc-version variable in TiCDC examples (`#21911`))
+  "tidb-version": "8.5.8",
+  "ticdc-version": "8.5.8",
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<<<<<<< HEAD
"tidb-version": "v8.5.0",
=======
"tidb-version": "8.5.8",
"ticdc-version": "8.5.8",
>>>>>>> 34087e135a (docs: use ticdc-version variable in TiCDC examples (#21911))
"tidb-version": "8.5.8",
"ticdc-version": "8.5.8",
🧰 Tools
🪛 Biome (2.5.8)

[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: unexpected character <

(parse)


[error] 3-3: String values must be double quoted.

(parse)


[error] 4-4: End of file expected

(parse)


[error] 4-4: End of file expected

(parse)


[error] 4-4: End of file expected

(parse)


[error] 4-5: End of file expected

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 5-5: unexpected character =

(parse)


[error] 6-6: End of file expected

(parse)


[error] 6-6: End of file expected

(parse)


[error] 6-6: End of file expected

(parse)


[error] 6-6: End of file expected

(parse)


[error] 7-7: End of file expected

(parse)


[error] 7-7: End of file expected

(parse)


[error] 7-7: End of file expected

(parse)


[error] 7-8: End of file expected

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: unexpected character >

(parse)


[error] 8-8: End of file expected

(parse)


[error] 8-8: String values must be double quoted.

(parse)


[error] 8-8: unexpected character (

(parse)


[error] 8-8: String values must be double quoted.

(parse)


[error] 8-8: End of file expected

(parse)


[error] 8-8: Minus must be followed by a digit

(parse)


[error] 8-8: unexpected character (

(parse)


[error] 8-8: unexpected character #

(parse)


[error] 8-8: End of file expected

(parse)


[error] 8-8: unexpected character )

(parse)


[error] 8-8: unexpected character )

(parse)

Source: Linters/SAST tools

Comment thread variables.json Outdated
@qiancai

qiancai commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Sep 4, 2026
@qiancai qiancai removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 4, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit bca8102 into pingcap:master Sep 4, 2026
11 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-21911-to-master branch September 4, 2026 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. lgtm ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants