refactor: enhance TOC file handling and regex patterns in scripts (#22033) #22034
Conversation
Signed-off-by: ti-chi-bot <[email protected]>
ti-chi-bot
added
do-not-merge/hold
|
@shhdgit This PR has conflicts, I have hold it. |
|
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. 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. |
Summary of ChangesHello @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 introduces significant refactoring to the documentation processing scripts, primarily focusing on improving the handling of Table of Contents (TOC) files and the parsing of custom content tags. The changes aim to enhance the flexibility and reliability of the documentation build process, especially for projects with multiple documentation versions or specific content filtering requirements, by allowing for the processing of multiple TOC files and more resilient regex matching. Highlights
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
|
![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 TOC file handling to support multiple files and improves regex patterns for more robust matching. The regex enhancements in merge_by_toc.py and utils.js are good improvements. However, there are critical issues with unresolved merge conflicts in both scripts/filterCloudDoc.js and scripts/utils.js that will prevent the scripts from running. Additionally, the refactored getAllMdList function in utils.js has a regression, as it no longer cleans up file paths, which could lead to issues.
scripts/filterCloudDoc.js
Outdated
| <<<<<<< HEAD | ||
| const allFilePaths = getAllCloudMdList(); | ||
|
|
||
| extractFilefromList(allFilePaths, "./", "./tmp"); | ||
| copySingleFileSync("TOC-tidb-cloud.md", "./tmp/TOC.md"); | ||
| ======= | ||
| const existingTocFiles = tocFiles.filter((file) => fs.existsSync(file)); | ||
| const filteredLinkList = getAllMdList(existingTocFiles); | ||
|
|
||
| extractFilefromList(filteredLinkList, ".", "./tmp"); | ||
|
|
||
| tocCopyTargets.forEach(({ src, dest }) => { | ||
| if (fs.existsSync(src)) { | ||
| copySingleFileSync(src, dest); | ||
| } | ||
| }); | ||
| >>>>>>> 2adf999c1d (refactor: enhance TOC file handling and regex patterns in scripts (#22033)) |
There was a problem hiding this comment.
This file contains unresolved merge conflict markers (<<<<<<< HEAD, =======, >>>>>>>). This is a critical issue that will cause the script to fail. Please resolve the conflict by removing the markers and the obsolete code block.
const existingTocFiles = tocFiles.filter((file) => fs.existsSync(file));
const filteredLinkList = getAllMdList(existingTocFiles);
extractFilefromList(filteredLinkList, ".", "./tmp");
tocCopyTargets.forEach(({ src, dest }) => {
if (fs.existsSync(src)) {
copySingleFileSync(src, dest);
}
});
|
@shhdgit: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this:
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. |
qiancai
removed
the
do-not-merge/hold
|
/approve |
|
[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
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
3 participants
This is an automated cherry-pick of #22033
First-time contributors' checklist
What is changed, added or deleted? (Required)
getAllMdListto accept multiple TOC files and avoid duplicate links.filterCloudDoc.jsto copy multiple TOC files to the temporary directory.merge_by_toc.pyandutils.jsfor better matching ofCustomContenttags.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?