Serverless changefeed #21272
+13,099
−3,418
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| $schema: "http://json-schema.org/draft-07/schema#" | ||
| title: RepoConfig | ||
| description: Configuration for Gemini Code Assist on a repository. | ||
|
|
||
| have_fun: false # Disables fun features like poems in PR summaries | ||
|
|
||
| code_review: | ||
| disable: false # Enables code reviews | ||
| comment_severity_threshold: LOW ## Allows low severity comments such as grammar and spelling mistakes to be added to the PR |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Documentation Review Style Guide | ||
|
|
||
| ## Behavior instruction | ||
|
|
||
| You are acting as a **senior technical writer** who is reviewing TiDB documentation pull requests and you always provide ready-to-commit doc suggestions so the PR author can commit them directly. | ||
|
|
||
| ## Note | ||
|
|
||
| - When you finish the review, you directly add comments to the PR instead of requesting changes to avoid blocking the pull request from being merged. | ||
| - If the PR author is ti-chi-bot, you only correct English grammar, spelling, and punctuation mistakes, if any. | ||
|
|
||
| ## Review aspects | ||
|
|
||
| - Clarity, simplicity, completeness, and readability | ||
| - Logical flow and sentence structure | ||
| - Technical accuracy and terminology consistency | ||
|
|
||
| ## General writing principles | ||
|
|
||
| - Correct English grammar, spelling, and punctuation mistakes, if any. | ||
| - Make sure the documentation is easy to understand for TiDB users. | ||
| - Write in **second person** ("you") when addressing users. | ||
| - Prefer **present tense** unless describing historical behavior. | ||
| - Avoid unnecessary words and repetition. | ||
| - Use **consistent terminology**. For example: | ||
|
|
||
| - ❌ Do not mix "database" and "instance" | ||
| - ✅ Use "replicate" instead of "synchronize" when referring to replicating data from one TiDB cluster to another. | ||
|
|
||
| ## Structure and format | ||
|
|
||
| - Use sentence case for headings (e.g., `## Configure the cluster`). | ||
| - Use ordered lists (`1.`, `2.`) for steps. | ||
| - Code snippets, command names, options, and paths should be in backticks (`` ` ``). | ||
|
|
||
| ## Markdown style | ||
|
|
||
| - Add a blank line before and after headings and lists. | ||
| - Use proper heading hierarchy (no jumping from `##` to `####`). | ||
|
|
||
| ## Common issues to flag | ||
|
|
||
| - Passive voice overuse | ||
|
|
||
| _"The cluster is started by TiUP"_ → _"TiUP starts the cluster"_ | ||
|
|
||
| - Inconsistent use of technical terms | ||
|
|
||
| _"TiDB Cloud Serverless clusters" vs. "TiDB Serverless clusters"_ – pick one. | ||
|
|
||
| - Unclear step instructions | ||
|
|
||
| _"Do it like before"_ → _"Repeat step 3 using the updated config file"_ | ||
|
|
||
| - Grammar and spelling issues | ||
|
|
||
| _"recieve"_ → _"receive"_, _"an TiDB instance"_ → _"a TiDB instance"_ | ||
|
|
||
| ## Special notes | ||
|
|
||
| - Follow any existing terminology in our glossary (`/glossary.md` if available). | ||
| - When in doubt, favor clarity over cleverness. | ||
| - If something might confuse a new user, suggest a reword. | ||
|
|
||
| ## Purposes of this style guide | ||
|
|
||
| This guide helps Gemini Code Assist provide actionable, high-quality suggestions for improving technical documentation, especially for PRs related to user guides, how-to articles, and product reference material. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| name: AI Doc Review | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| issue_comment: | ||
| types: | ||
| - created | ||
|
|
||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| issues: write | ||
|
|
||
| jobs: | ||
| review: | ||
| runs-on: ubuntu-latest | ||
| if: > | ||
| github.event_name == 'workflow_dispatch' || | ||
| ( | ||
| github.event_name == 'issue_comment' && | ||
| contains(github.event.comment.body, '/bot-review') && | ||
| (github.event.comment.user.login == 'hfxsd' || github.event.comment.user.login == 'likidu' || github.event.comment.user.login == 'lilin90' || github.event.comment.user.login == 'Oreoxmt' || github.event.comment.user.login == 'qiancai') | ||
| ) | ||
| steps: | ||
| - name: Checkout Repo | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 # Fetch all history for all branches and tags | ||
|
|
||
| - name: Extract review parameters | ||
| id: extract | ||
| if: github.event_name == 'issue_comment' | ||
| run: | | ||
| COMMENT="${{ github.event.comment.body }}" | ||
| # Match commit range | ||
| if [[ "$COMMENT" =~ \/bot-review:[[:space:]]*([a-f0-9]{7,40})[[:space:]]*\.\.[[:space:]]*([a-f0-9]{7,40}) ]]; then | ||
| echo "BASE_SHA=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT | ||
| echo "HEAD_SHA=${BASH_REMATCH[2]}" >> $GITHUB_OUTPUT | ||
| echo "REVIEW_MODE=commit_range" >> $GITHUB_OUTPUT | ||
| printf "Detected commit range with regex: %s..%s\\n" "${BASH_REMATCH[1]}" "${BASH_REMATCH[2]}" | ||
| # Match a single commit | ||
| elif [[ "$COMMENT" =~ \/bot-review:[[:space:]]+([a-f0-9]{7,40}) ]]; then | ||
| echo "COMMIT_SHA=${BASH_REMATCH[1]}" >> $GITHUB_OUTPUT | ||
| echo "REVIEW_MODE=single_commit" >> $GITHUB_OUTPUT | ||
| printf "Detected single commit: %s\\n" "${BASH_REMATCH[1]}" | ||
| # Match "/bot-review" or "/bot-review " | ||
| elif [[ "$COMMENT" =~ ^\/bot-review[[:space:]]*$ ]]; then | ||
| echo "REVIEW_MODE=latest" >> $GITHUB_OUTPUT | ||
| echo "Detected default review mode" | ||
| # Invalid format | ||
| else | ||
| echo "REVIEW_MODE=invalid" >> $GITHUB_OUTPUT | ||
| echo "Invalid bot-review command format" | ||
| fi | ||
| echo "Parameters output:" | ||
| cat $GITHUB_OUTPUT | ||
| - name: AI Doc Reviewer | ||
| uses: qiancai/ai-doc-reviewer@main | ||
| continue-on-error: false # Ensure workflow fails if the action fails | ||
| with: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| API_PROVIDER: "openai" # or "openai" if you want to use OpenAI | ||
| OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }} | ||
| OPENAI_API_MODEL: "gpt-4o" | ||
| exclude: "**/*.json" # Optional: exclude patterns separated by commas | ||
| REVIEW_MODE: ${{ steps.extract.outputs.REVIEW_MODE || 'default' }} | ||
| COMMIT_SHA: ${{ steps.extract.outputs.COMMIT_SHA || '' }} | ||
| BASE_SHA: ${{ steps.extract.outputs.BASE_SHA || '' }} | ||
| HEAD_SHA: ${{ steps.extract.outputs.HEAD_SHA || '' }} | ||
| PROMPT_PATH: "doc-review-prompt.txt" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These URLs are specific to versions 6.6 and 7.6. Consider using a more general pattern or including URLs for other versions as well to ensure comprehensive link checking.