Skip to content

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

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

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

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 / TiDB-coupled 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

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

  • This PR is translated from:
  • Other reference link(s): Ask Docs thread about using a dedicated TiCDC version variable because TiCDC release cadence might diverge from TiDB

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

  • Documentation

    • Updated TiCDC deployment examples to use a configurable version placeholder instead of fixed version numbers.
    • Applied the placeholder consistently across TiUP and TiDB Operator scenarios.
  • Configuration

    • Added the TiCDC version setting, currently set to 8.5.8.

@doc-claw-bot doc-claw-bot added the ONCALL Relates to documentation oncall. 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: 0a404aff-5820-4da1-b96b-4a4ba4e938b4

📥 Commits

Reviewing files that changed from the base of the PR and between 75a79ad and 318d213.

📒 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

The change adds the TiCDC version to variables.json and updates five TiCDC architecture deployment examples to use the ticdc-version template variable.

Changes

TiCDC version templating

Layer / File(s) Summary
Version configuration and deployment examples
variables.json, ticdc/ticdc-architecture.md
variables.json adds ticdc-version with value 8.5.8. Five TiDB Operator and TiUP examples now use v{{{ .ticdc-version }}} instead of hardcoded TiCDC versions.

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

Merge Risk: ⚪ Minimal · up to 318d2

This change only updates TiCDC documentation examples to use a dedicated version variable, with release-threshold statements preserved. No actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: qiancai, ti-chi-bot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, clear, and directly identifies the main change: using the dedicated ticdc-version variable in TiCDC examples.
Description check ✅ Passed The description explains the changes, identifies the affected TiDB version, and provides related context. It omits the AI agent involvement section and uses version checklist entries that differ from …
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.
Full details: Description check

Explanation

The description explains the changes, identifies the affected TiDB version, and provides related context. It omits the AI agent involvement section and uses version checklist entries that differ from the repository template, but the required content is mostly complete.

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.

@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 changed the title docs: use tidb-version variable in TiCDC new architecture examples docs: use ticdc-version variable in TiCDC examples Sep 2, 2026
@doc-claw-bot
doc-claw-bot force-pushed the docs/ticdc-newarch-version-variable branch from 6457be2 to 318d213 Compare September 2, 2026 02:49
@qiancai qiancai added needs-cherry-pick-master Should cherry pick this PR to master branch. and removed missing-translation-status This PR does not have translation status info. labels Sep 2, 2026
@qiancai
qiancai requested a review from asddongmen September 2, 2026 03:03
@doc-claw-bot doc-claw-bot added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Sep 2, 2026
@qiancai qiancai added the area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. label Sep 2, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

@asddongmen: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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 kubernetes-sigs/prow repository.

@qiancai qiancai self-assigned this Sep 3, 2026
@qiancai

qiancai commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Sep 3, 2026
@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 aa389a3 into pingcap:release-8.5 Sep 3, 2026
12 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #23729.
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/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants