ci: refactor file diff update #22229
Conversation
…d utility functions for cloud TOC processing
… and enhancing file download process
…rect source directories
…tory for input and output paths
…rce directory for JavaScript files
…rrect script paths for execution
Summary of ChangesHello @shhdgit, 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 refactors the continuous integration (CI) scripts responsible for updating and managing documentation files. It streamlines the process by removing two older, specialized scripts and centralizing robust file and Table of Contents (TOC) parsing logic within a shared utility file. This change aims to improve the maintainability and reliability of the documentation update workflow, particularly for cloud-specific content. Highlights
🧠 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. Ignored Files
Using Gemini Code AssistThe 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
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 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
|
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request refactors the CI process for handling file diff updates. It achieves this by removing the scripts/fetchFiles.js and scripts/filterUpdateFiles.js scripts and enhancing scripts/utils.js with more robust TOC file processing and new helper functions. The changes improve error handling when reading TOC files and centralize logic for handling lists of TOCs. I have one suggestion to simplify the new getAllCloudMdList function for better code clarity and to avoid redundant operations. Overall, this is a positive refactoring that improves the structure and reliability of the scripts.
scripts/utils.js
Outdated
| // Get all MD files from multiple TOCs and deduplicate | ||
| const allFilteredLinkLists = tocFiles.map((tocFile) => getAllMdList(tocFile)); | ||
| const flattenedList = allFilteredLinkLists.flat(); | ||
| const allFilePaths = [...new Set(flattenedList)]; // Deduplicate | ||
| return allFilePaths; |
There was a problem hiding this comment.
This function's implementation can be significantly simplified. The getAllMdList function already accepts an array of TOC files, processes them, and returns a deduplicated list of markdown file paths. You can delegate the call directly to it. This makes the code more concise and avoids redundant logic.
| // Get all MD files from multiple TOCs and deduplicate | |
| const allFilteredLinkLists = tocFiles.map((tocFile) => getAllMdList(tocFile)); | |
| const flattenedList = allFilteredLinkLists.flat(); | |
| const allFilePaths = [...new Set(flattenedList)]; // Deduplicate | |
| return allFilePaths; | |
| return getAllMdList(tocFiles); |
ti-chi-bot
bot
removed
the
missing-translation-status
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?