Skip to content

[v8.5.6] docs: update sync-diff-inspector docs for move to tiflow repo (#20140)#22540

Open
ti-chi-bot wants to merge 11 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-20140-to-release-8.5
Open

[v8.5.6] docs: update sync-diff-inspector docs for move to tiflow repo (#20140)#22540
ti-chi-bot wants to merge 11 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-20140-to-release-8.5

Conversation

@ti-chi-bot
Copy link
Member

@ti-chi-bot ti-chi-bot commented Mar 6, 2026

This is an automated cherry-pick of #20140

What is changed, added or deleted? (Required)

This PR updates the documentation to reflect the move of sync_diff_inspector from tidb-tools to tiflow repository for TiDB 9.0.0 and later versions. The changes include:

  • Update GitHub repository links from tidb-tools to tiflow
  • Add TiUP installation method for v9.0.0+
  • Update Docker image references
  • Add version-specific installation instructions
  • Update download-ecosystem-tools.md with new package information

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

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

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

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

alastori and others added 9 commits March 6, 2026 04:10
- Update GitHub repository links from tidb-tools to tiflow

- Add TiUP installation method for v9.0.0+

- Update Docker image references

- Add version-specific installation instructions

- Update download-ecosystem-tools.md with new package information
Update Docker image for sync-diff-inspector

The previous `docker pull pingcap/tiflow:latest` command was incorrect. After confirming with Flare Zuo (R&D Group - Engineering Productivity - Efficiency & Ops team), we should use `docker pull pingcap/sync-diff-inspector:latest` to align with TiCDC and DM, ensuring consistency across TiFlow-managed images.

This update reflects the correct image name for better usability.
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: Aolin <aolinz@outlook.com>
@ti-chi-bot ti-chi-bot added area/sync-diff-inspector Indicates that the Issue or PR belongs to the area of sync-diff-inspector. 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. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1. labels Mar 6, 2026
@hfxsd hfxsd self-assigned this Mar 6, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation for the sync-diff-inspector tool to reflect its migration to the tiflow repository. The changes provide clearer, version-specific installation guidance, including new TiUP commands and updated Docker image references, ensuring users can correctly access and deploy the tool based on their TiDB version.

Highlights

  • Repository Migration: The sync-diff-inspector tool's GitHub repository link has been updated from tidb-tools to tiflow to reflect its new home.
  • Installation Methods: New TiUP installation instructions have been added specifically for TiDB v9.0.0 and later versions.
  • Docker Image References: Docker image references for sync-diff-inspector have been updated to align with the new repository and versioning.
  • Version-Specific Guidance: The documentation now provides distinct installation instructions based on the TiDB version, differentiating between v9.0.0+ and older versions.
  • Ecosystem Tools Update: The download-ecosystem-tools.md file has been updated to include sync-diff-inspector in the TiDB Toolkit description and provide version-specific download information.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • download-ecosystem-tools.md
    • Included sync-diff-inspector in the list of tools within the TiDB Toolkit description.
    • Updated the TiUP tip to clarify that for TiDB v9.0.0 and later, sync-diff-inspector is available via TiUP.
    • Modified the sync-diff-inspector download package information to specify different packages for TiDB v9.0.0+ and older versions.
  • sync-diff-inspector/sync-diff-inspector-overview.md
    • Updated the GitHub repository link for sync-diff-inspector from tidb-tools to tiflow.
    • Removed the generic download instructions for binary packages and Docker images.
    • Added a new "Install sync-diff-inspector" section with detailed, version-specific installation methods for TiDB v9.0.0+ (TiUP, binary, Docker) and versions before v9.0.0 (legacy binary, Docker).
    • Removed two lines of example data from a comment block.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 6, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from hfxsd. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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

@hfxsd hfxsd changed the title docs: update sync-diff-inspector docs for move to tiflow repo (#20140) [v8.5.6 ] docs: update sync-diff-inspector docs for move to tiflow repo (#20140) Mar 6, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This PR updates the documentation for sync-diff-inspector to reflect its move to the tiflow repository. The changes are mostly good, updating links and adding version-specific installation instructions. I've provided a few suggestions to improve clarity, conciseness, and adherence to the documentation style guide, such as using backticks for tool names and simplifying some sentences. I also noticed an example was made less clear by a deletion and suggested restoring the deleted content.

Note: Security Review has been skipped due to the limited scope of the PR.

@hfxsd hfxsd changed the title [v8.5.6 ] docs: update sync-diff-inspector docs for move to tiflow repo (#20140) [v8.5.6] docs: update sync-diff-inspector docs for move to tiflow repo (#20140) Mar 6, 2026
@hfxsd hfxsd added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 6, 2026
Copy link
Contributor

@joechenrh joechenrh left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Comment on lines -285 to -286
╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╋╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍╍
target data ╏ 5003616 ╏ '0709824117-9809973320-4456050422' ╏ '1714066100-7057807621-1425865505'
Copy link
Contributor

Choose a reason for hiding this comment

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

Preserve these two lines

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 6, 2026

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

Details

In response to this:

Rest LGTM

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.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@hfxsd hfxsd added the needs-cherry-pick-master Should cherry pick this PR to master branch. label Mar 6, 2026
Copy link
Contributor

@joechenrh joechenrh left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 6, 2026

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

Details

In response to this:

LGTM

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/sync-diff-inspector Indicates that the Issue or PR belongs to the area of sync-diff-inspector. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm needs-cherry-pick-master Should cherry pick this PR to master branch. 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. type/compatibility-or-feature-change This PR involves compatibility changes or feature behavior changes. v9.0-beta.1 This PR/issue applies to TiDB v9.0-beta.1.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants