Skip to content

tidb-lightning: recommend matching TiDB Lightning and TiDB versions (#23909) - #23917

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

ti-chi-bot[bot] merged 3 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23909-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 #23909

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.
  • Specify the matching version in TiUP installation and quick-start launch examples, and retain the original task's version in the FAQ restart example.
  • 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 example-data and migration guides identified in review and their available translations.

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.

  • 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

  • Documentation
    • Updated TiDB Lightning installation, startup, import, restart, and troubleshooting guidance to use an explicitly specified version.
    • Recommended matching the TiDB Lightning version with the target TiDB cluster version.
    • Clarified version selection in tutorials, deployment instructions, FAQs, and performance troubleshooting guidance.
    • Removed outdated guidance referencing unsupported early TiDB versions and generic “latest version” recommendations.

@ti-chi-bot ti-chi-bot added 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
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 1b87c61e-4eca-4b38-9338-1c24d7c3e233

📥 Commits

Reviewing files that changed from the base of the PR and between 63ffe3e and 56e1919.

📒 Files selected for processing (8)
  • get-started-with-tidb-lightning.md
  • import-example-data.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; 2 remain after this review.


📝 Walkthrough

Walkthrough

The documentation replaces unversioned or latest-version TiDB Lightning commands with explicit versions that match the target TiDB cluster. Deployment, restart, FAQ, and troubleshooting guidance now uses the same version-matching rule.

Changes

TiDB Lightning version guidance

Layer / File(s) Summary
Versioned installation and import commands
get-started-with-tidb-lightning.md, import-example-data.md, migrate-from-sql-files-to-tidb.md, migrate-large-mysql-to-tidb.md, tidb-lightning/deploy-tidb-lightning.md
Installation, startup, and import commands now use tiup tidb-lightning:<version>. The instructions tell readers to match the version to the target TiDB cluster.
Deployment and restart guidance
tidb-lightning/deploy-tidb-lightning.md, tidb-lightning/tidb-lightning-faq.md
Manual deployment and restart instructions now use the target cluster version. The FAQ replaces backend-version requirements with version-selection guidance.
Troubleshooting version guidance
tidb-lightning/troubleshoot-tidb-lightning.md, tidb-troubleshooting-map.md
Troubleshooting guidance now recommends a newer TiDB Lightning release that matches the target TiDB cluster when upgrading.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: recommending matching TiDB Lightning and TiDB cluster versions.
Description check ✅ Passed The description is complete and follows the required template. It explains the changes, affected version, related links, AI involvement, validation, and applicable change classifications.
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.

@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
@ti-chi-bot
ti-chi-bot Bot merged commit 575260c into pingcap:release-8.5 Sep 21, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23909-to-release-8.5 branch September 21, 2026 02:37
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