Skip to content

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

Merged
ti-chi-bot[bot] merged 1 commit into
pingcap:release-8.5from
doc-claw-bot:docs/ticdc-version-variable-23696
Sep 3, 2026
Merged

docs: use ticdc-version variable in TiCDC examples#21911
ti-chi-bot[bot] merged 1 commit into
pingcap:release-8.5from
doc-claw-bot:docs/ticdc-version-variable-23696

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

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。

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 2, 2026
@doc-claw-bot doc-claw-bot added the translation/from-docs This PR is translated from a PR in pingcap/docs. label Sep 2, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 2, 2026
@coderabbitai

coderabbitai Bot commented Sep 2, 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: 763fa4e7-e633-46d3-8a0d-d135b7f6fd22

📥 Commits

Reviewing files that changed from the base of the PR and between 70a923c and 5e913ec.

📒 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.


📝 Walkthrough

Walkthrough

本次变更新增 TiCDC 版本变量,并将 TiCDC 部署文档中的固定版本替换为模板变量。默认 TiCDC 版本设置为 8.5.8

Changes

TiCDC 版本模板化

Layer / File(s) Summary
新增 TiCDC 版本变量
variables.json
新增 ticdc-version 字符串变量,默认值为 8.5.8
更新 TiCDC 部署示例
ticdc/ticdc-architecture.md
TiDB Operator 配置、离线包下载命令和 tiup cluster patch 命令改用 {{{ .ticdc-version }}} 生成 TiCDC 版本。

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

Merge Risk: ⚪ Minimal · up to 5e913

This localized documentation change is merge-ready after normal checks and review; no actionable merge-blocking risk remains.

Suggested reviewers: qiancai, ti-chi-bot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed 标题准确概括了主要变更,即在 TiCDC 示例中使用 ticdc-version 变量。标题简洁、明确,并与变更内容一致。
Description check ✅ Passed 描述包含变更内容、适用版本、相关链接、AI agent involvement 以及变更类型检查项。描述明确说明了保留 release-threshold statements 的范围,整体符合模板要求。
Full details: Docstring Coverage

Explanation

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 files. (2 skipped: 2 unsupported.)

✨ 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.

@qiancai qiancai added ONCALL Relates to documentation oncall. needs-cherry-pick-master Should cherry pick this PR to master branch. area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. lgtm labels Sep 2, 2026
@qiancai

qiancai commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 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 3, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 34087e1 into pingcap:release-8.5 Sep 3, 2026
11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #21917.
But this PR has conflicts, please resolve them!

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 needs-cherry-pick-master Should cherry pick this PR to master branch. ONCALL Relates to documentation oncall. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants