Skip to content

tidb-lightning: recommend matching TiDB Lightning and TiDB versions (#21945) - #21946

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21945-to-release-8.5
Sep 21, 2026
Merged

ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21945-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21945

What is changed, added, or deleted? (Required)

Recommend using the same version of TiDB Lightning as the target TiDB cluster consistently across the deployment guide, FAQ, quick start, and troubleshooting documentation.

  • Replace the blanket backward-compatibility claim and latest-version recommendation in the deployment guide with the matching-version recommendation.
  • Reframe the FAQ as "Which TiDB Lightning version should I use?" and focus the answer on matching the target TiDB cluster version instead of historical minimum-version information. Update the Chinese FAQ summary accordingly.
  • Specify the matching version in TiUP installation and quick-start launch examples, retain the original task's version in the FAQ restart example, and align the quick-start summary.
  • Align upgrade advice in both troubleshooting pages with the same recommendation.
  • Address review feedback: use the documentation version variable in examples, link the installation step, clarify restart wording, and pin the Lightning version in the additional migration guides identified in review and align them with the English documentation.

This is a documentation guidance correction, not a product behavior change.

Validation: git diff --check and the repository's ./scripts/markdownlint passed for all changed Markdown files. The version-selection FAQ heading was changed; searches in both repositories found no references to its old anchor. The new Step 3 links were checked against the installation headings. No page aliases were changed. TiUP installation and version-pinned execution were also smoke-tested with Lightning v8.5.0; no data import was performed.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions (in Chinese).

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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

  • 文档
    • 更新 TiDB Lightning 安装、启动和重启指南,建议使用与目标 TiDB 集群版本一致的 TiDB Lightning。
    • 同步更新在线部署、手动部署及 SQL、MySQL、Amazon S3 导入示例,要求在命令中指定对应版本。
    • 更新 FAQ 和故障排查内容,补充版本选择建议,并说明较新版本可能改善导入性能。

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot ti-chi-bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Sep 21, 2026
@ti-chi-bot

Copy link
Copy Markdown
Member Author

@YangKeao 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 21, 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 21, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs-cn/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 064b8776-ae9c-4db4-8a3b-e1186546392e

📥 Commits

Reviewing files that changed from the base of the PR and between d75aea9 and 18f7d36.

📒 Files selected for processing (2)
  • get-started-with-tidb-lightning.md
  • tidb-lightning/tidb-lightning-faq.md
💤 Files with no reviewable changes (2)
  • tidb-lightning/tidb-lightning-faq.md
  • get-started-with-tidb-lightning.md

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


📝 Walkthrough

Walkthrough

本次更新了 TiDB Lightning 的安装、启动、部署、FAQ 和故障排查文档。文档建议使用与目标 TiDB 集群相同版本的 TiDB Lightning,并更新相关命令示例。

Changes

TiDB Lightning 版本匹配指导

Layer / File(s) Summary
安装与迁移命令更新
get-started-with-tidb-lightning.md、migrate-from-sql-files-to-tidb.md、migrate-large-mysql-to-tidb.md
安装和启动命令改为使用 tidb-lightning:<version>,并增加版本替换说明。
部署与 FAQ 说明更新
tidb-lightning/deploy-tidb-lightning.md、tidb-lightning/tidb-lightning-faq.md
部署文档更新版本选择建议、安装命令和手动下载说明。FAQ 更新版本选择摘要、相关回答、别名和重启命令,并删除旧的最低版本要求说明。
故障排查版本建议
tidb-lightning/troubleshoot-tidb-lightning.md、tidb-troubleshooting-map.md
版本过旧相关说明改为建议使用较新且与目标 TiDB 集群相同版本的 TiDB Lightning。

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了主要变更,即建议 TiDB Lightning 与目标 TiDB 集群使用相同版本。标题简洁且具体。
Description check ✅ Passed 描述覆盖了变更内容、适用版本、相关链接、AI 参与情况和验证结果,整体符合模板要求。根据文件摘要,FAQ 新增了 aliases 字段,但描述中称未修改 aliases;该处需要在合并前核对并保持一致。
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 a new PR

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: 3


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs-cn/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 831b9879-6472-4c8e-833f-842de4d27758

📥 Commits

Reviewing files that changed from the base of the PR and between 4616565 and d75aea9.

📒 Files selected for processing (7)
  • get-started-with-tidb-lightning.md
  • migrate-from-sql-files-to-tidb.md
  • migrate-large-mysql-to-tidb.md
  • tidb-lightning/deploy-tidb-lightning.md
  • tidb-lightning/tidb-lightning-faq.md
  • tidb-lightning/troubleshoot-tidb-lightning.md
  • tidb-troubleshooting-map.md

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

Comment thread get-started-with-tidb-lightning.md Outdated
Comment thread tidb-lightning/tidb-lightning-faq.md Outdated
Comment thread tidb-lightning/tidb-lightning-faq.md
Comment thread get-started-with-tidb-lightning.md Outdated
Comment thread tidb-lightning/tidb-lightning-faq.md Outdated
@qiancai

qiancai commented Sep 21, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 21, 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 21, 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 21, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit b5984d9 into pingcap:release-8.5 Sep 21, 2026
11 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-21945-to-release-8.5 branch September 21, 2026 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants