ignore tidb operator links with variables#21706
ignore tidb operator links with variables#21706ti-chi-bot[bot] merged 2 commits intopingcap:masterfrom
Conversation
![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 @dveeden, 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's link checking configuration to correctly handle URLs that include dynamic variables. By ignoring these specific patterns, it ensures that the automated link checker does not report false positives for valid, programmatically generated links within the TiDB Operator documentation.
Highlights
- Link Checker Configuration: Added a new regex pattern to the .lycheeignore file to prevent the link checker (lychee) from flagging valid TiDB Operator documentation links that contain dynamic version variables as broken.
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. 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
-
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
Bot
added
missing-translation-status
There was a problem hiding this comment.
Code Review
This pull request adds a URL pattern to the .lycheeignore file to prevent the link checker from failing on a templated URL for the TiDB Operator repository. The change is correct and addresses the issue. I've added one suggestion to improve the readability and robustness of the ignore pattern.
| https://docs\.pingcap\.com/tidb/v6\.6/system-variables#tidb_pessimistic_txn_aggressive_locking-new-in-v660 | ||
| https://docs\.pingcap\.com/tidb/v7\.6/system-variables#tidb_ddl_version-new-in-v760 | ||
| https://developers\.redhat\.com/blog/2021/01/05/building-red-hat-enterprise-linux-9-for-the-x86-64-v2-microarchitecture-level | ||
| https://github\.com/pingcap/tidb-operator/blob/%7B%7B%7B%20.tidb_operator_version%20%7D%7D%7D |
There was a problem hiding this comment.
This entry works, but it could be more readable and robust by using an unencoded regular expression. A more general pattern would also prevent similar issues with other templated links in the future, which seems to align with the PR title mentioning "links" in plural.
https://github\.com/pingcap/tidb-operator/blob/\{\{\{.*
[LGTM Timeline notifier]Timeline:
|
Oreoxmt
added
translation/no-need
ti-chi-bot
Bot
removed
the
missing-translation-status
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
What is changed, added or deleted? (Required)
See pingcap/docs-tidb-operator#2917
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?