v8.5 refactor: consolidate TOC file handling in cloud document scripts (#21512) #21514
Conversation
… cloud document scripts
…tency in cloud document scripts
…ud document scripts
…onCloudDoc script
ti-chi-bot
added
lgtm
needs-1-more-lgtm
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 and consolidates the handling of Table of Contents (TOC) files within the cloud documentation processing scripts. The primary goal is to streamline how markdown files related to TiDB Cloud documentation are identified, filtered, and prepared, by centralizing the logic for parsing multiple cloud-specific TOC files and introducing a dedicated script for initial file setup.
Highlights
- Consolidated TOC Handling: Introduced
CLOUD_TOC_LISTandgetAllCloudMdListinscripts/utils.jsto centralize the logic for reading and combining file paths from multiple cloud-specific Table of Contents (TOC) files, such asTOC-tidb-cloud.md,TOC-tidb-cloud-essential.md, andTOC-tidb-cloud-starter.md. - New Initialization Script: Added a new script,
scripts/filterCloudInitFiles.js, which is responsible for filtering and copying relevant cloud documentation markdown files into a temporary directory (./tmp) based on the consolidated TOC information. It skips external links, anchor links, and files already within thetidb-cloud/folder. - Improved Path Normalization: Enhanced the
getAllMdListutility function to ensure consistent path formatting by automatically removing leading./or/from file paths extracted from TOCs. - Refactored Script Dependencies: Updated existing scripts (
scripts/filterCloudDoc.js,scripts/filterNonCloudDoc.js,scripts/filterUpdateFiles.js) to leverage the new consolidated TOC handling utilities, removing redundant or specific TOC parsing logic from individual files and promoting code reuse.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors the handling of Table of Contents (TOC) files for cloud documentation scripts. It centralizes the list of cloud TOC files and introduces a new utility function getAllCloudMdList to parse multiple TOCs. The old regex-based parsing is replaced with a more robust AST-based approach. This is a good improvement for maintainability and robustness.
I've found a critical bug in a new script and a minor maintainability issue. Please address the critical issue before merging. The style guide was followed in providing feedback.
| } | ||
|
|
||
| // Skip files in tidb-cloud folder | ||
| if (cleanPath.startsWith("tidb-cloud/")) { |
There was a problem hiding this comment.
The variable cleanPath is used here but it has not been defined in this scope, which will cause a ReferenceError at runtime. Based on the context of the loop, you likely intended to use filePath.
| if (cleanPath.startsWith("tidb-cloud/")) { | |
| if (filePath.startsWith("tidb-cloud/")) { |
| continue; | ||
| } | ||
|
|
||
| filePaths.add(cleanPath); |
There was a problem hiding this comment.
Similar to the issue above, the undefined variable cleanPath is used here. It should be filePath to add the correct path to the filePaths set.
| filePaths.add(cleanPath); | |
| filePaths.add(filePath); |
| const getCloudTOCFiles = () => { | ||
| // check ./tmp/TOC-tidb-cloud.md first | ||
| const tmpTocPath = "./tmp/TOC-tidb-cloud.md"; | ||
| const localTocPath = "TOC-tidb-cloud.md"; | ||
| const tmpTocFiles = getAllCloudMdList([ | ||
| "./tmp/TOC-tidb-cloud.md", | ||
| "./tmp/TOC-tidb-cloud-starter.md", | ||
| "./tmp/TOC-tidb-cloud-essential.md", | ||
| ]); | ||
| const tocFiles = getAllCloudMdList(CLOUD_TOC_LIST); |
There was a problem hiding this comment.
The getCloudTOCFiles function is retrieving TOC files from both the tmp directory and the current directory. To improve maintainability and reduce redundancy, consolidate the logic by directly using getAllCloudMdList with both the temporary and current TOC file paths.
This change simplifies the function and ensures consistency in how TOC files are handled.
const getCloudTOCFiles = () => {
const tmpTocFiles = CLOUD_TOC_LIST.map((tocFile) => `./tmp/${tocFile}`);
const allTocFiles = [...tmpTocFiles, ...CLOUD_TOC_LIST];
const finalTocFiles = new Set(getAllCloudMdList(allTocFiles));
if (finalTocFiles.size === 0) {
console.log("Warning: No TOC file found or no files in TOC. All .md files will be processed.");
}
return finalTocFiles;
};
lilin90
changed the title
|
Note: Since all the changes on |
This is an automated cherry-pick of #21512
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?