feat: treat `main` branch as `dev` version for Operator docs #651

Oreoxmt · 2025-11-21T09:19:14Z

Update the version handling logic to treat the main branch as dev version specifically for TiDB Operator documentation.

vercel · 2025-11-21T09:19:20Z

@Oreoxmt is attempting to deploy a commit to the pingcap Team on Vercel.

A member of the Team first needs to authorize it.

gemini-code-assist · 2025-11-21T09:19:27Z

Summary of Changes

Hello @Oreoxmt, I'm Gemini Code Assist¹! 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 support for the 'main' branch in the versioning system. It modifies several utility functions to treat 'main' identically to 'master' when determining the 'dev' version of a repository's documentation. This update is crucial for maintaining compatibility and correct version resolution for projects that have transitioned from 'master' to 'main' as their default branch.

Highlights

Main Branch Support: The versioning logic has been updated to recognize 'main' as an alias for the development branch, ensuring that both 'master' and 'main' branches correctly map to the 'dev' version.
Consistent Version Resolution: This change ensures that repositories using 'main' as their primary branch will have their documentation correctly resolved to the 'dev' version, aligning with modern branching conventions.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

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. ↩

gemini-code-assist

Code Review

This PR correctly adds support for the main branch to be treated as dev. The changes are consistent across the codebase. I've added a couple of comments pointing out opportunities to refactor some duplicated utility functions. Addressing this will improve code maintainability. Nice work!

gemini-code-assist · 2025-11-21T09:20:34Z

gatsby/path.ts

      const stable = CONFIG.docs[repo].stable;
      switch (branch) {
        case "master":
+        case "main":


Good catch adding main here. I see this branchToVersion function is also present in src/shared/utils/index.ts. Let's keep our codebase DRY and consolidate them. We should export the one from src/shared/utils/index.ts and use it here.

gemini-code-assist · 2025-11-21T09:20:34Z

gatsby/utils.ts

 function renameVersion(version: string, stable: string | undefined) {
  switch (version) {
    case "master":
+    case "main":


Thanks for updating this. This renameVersion function is almost a mirror of convertVersionName in src/shared/utils/index.ts. To avoid future maintenance headaches, let's merge them. The version in shared/utils should probably be updated to handle an undefined stable version, and then we can use it here.

Oreoxmt · 2025-11-21T10:49:58Z

/gemini review

gemini-code-assist

Code Review

This pull request updates the version handling logic to treat the main branch as the dev version for TiDB Operator documentation. The changes are applied correctly across several files. However, this introduces significant code duplication for the branch-to-version conversion logic. My review includes suggestions to refactor this into a centralized utility function to improve maintainability.

gemini-code-assist · 2025-11-21T10:52:19Z

gatsby/path.ts

+      const devBranch = repo === Repo.operator ? "main" : "master";
      const stable = CONFIG.docs[repo].stable;
      switch (branch) {
-        case "master":
+        case devBranch:


This logic is duplicated in other files. Please see my comment on gatsby/utils.ts for a suggestion to centralize this into a reusable utility function to improve maintainability.

gemini-code-assist · 2025-11-21T10:52:19Z

gatsby/utils.ts

+    case "tidb-in-kubernetes": {
+      const devBranch = doc === "tidb-in-kubernetes" ? "main" : "master";
+      const stable = getStable(doc);
+      switch (version) {
+        case devBranch:
+          return "dev";
+        case stable:
+          return "stable";
+        default:
+          return version.replace("release-", "v");
+      }
+    }


While this change is functionally correct, the logic for determining the dev branch and converting it to a version name is now duplicated in at least three places (gatsby/path.ts, gatsby/utils.ts, and src/shared/utils/index.ts).

To improve maintainability and follow the DRY (Don't Repeat Yourself) principle, I recommend extracting this logic into a single, reusable utility function. You could re-introduce a function similar to the renameVersion that was removed, but make it more generic and export it so it can be used across the codebase.

For example:

// Could be placed in a shared utils file export function getVersionFromBranch(branch: string, repo: Repo, stable: string | undefined) { const devBranch = repo === 'tidb-in-kubernetes' ? 'main' : 'master'; switch (branch) { case devBranch: return 'dev'; case stable: return 'stable'; default: return branch.replace('release-', 'v'); } }

Using this helper would simplify the code in all affected locations.

gemini-code-assist · 2025-11-21T10:52:19Z

src/shared/utils/index.ts

+      const devBranch = repo === Repo.operator ? "main" : "master";
      const stable = CONFIG.docs[repo].stable;
      switch (branch) {
-        case "master":
+        case devBranch:


This logic is duplicated in other files. Please see my comment on gatsby/utils.ts for a suggestion to centralize this into a reusable utility function to improve maintainability.

gemini-code-assist · 2025-11-21T10:52:19Z

src/shared/utils/index.ts

+  const devBranch = repo === "tidb-in-kubernetes" ? "main" : "master";
  switch (version) {
-    case "master":
+    case devBranch:


The logic for determining the dev branch is duplicated here as well. While the default case of this switch is different, the dev branch logic could still be shared. Please see my main comment on gatsby/utils.ts for a refactoring suggestion.

Oreoxmt · 2025-11-21T11:02:15Z

Preview environment

TiDB Operator:
- The /dev page now correctly builds from the main branch
- Preview: https://pingcap-docsite-preview-git-operator-m-62c34b-oreoxmts-projects.vercel.app/tidb-in-kubernetes/dev/tidb-operator-overview/
- Source: markdown-pages/en/tidb-in-kubernetes/main/tidb-operator-overview.md
TiDB (unchanged):
- The /dev page continues to build from the master branch (as expected)
- Preview: https://pingcap-docsite-preview-git-operator-m-62c34b-oreoxmts-projects.vercel.app/tidb/dev/overview/
- Source: markdown-pages/en/tidb/master/overview.md

shhdgit

lgtm.

feat: return "dev" for Operator main branch

05c22a3

gemini-code-assist bot reviewed Nov 21, 2025

View reviewed changes

Oreoxmt force-pushed the feat/support-operator-main branch from 35d5925 to 05bb57f Compare November 21, 2025 09:33

Oreoxmt added 2 commits November 21, 2025 17:33

feat: return "dev" for Operator main branch

05bb57f

refactor

844daba

Oreoxmt changed the title ~~feat: return "dev" for Operator main branch~~ feat: treat main branch as dev version for Operator docs Nov 21, 2025

gemini-code-assist bot reviewed Nov 21, 2025

View reviewed changes

shhdgit approved these changes Nov 21, 2025

View reviewed changes

feat: treat main branch as dev version for Operator docs #651

Are you sure you want to change the base?

feat: treat main branch as dev version for Operator docs #651

Conversation

Oreoxmt commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Nov 21, 2025

Uh oh!

gemini-code-assist bot commented Nov 21, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Oreoxmt commented Nov 21, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Oreoxmt commented Nov 21, 2025

Uh oh!

shhdgit left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: treat `main` branch as `dev` version for Operator docs #651

feat: treat `main` branch as `dev` version for Operator docs #651

Oreoxmt commented Nov 21, 2025 •

edited

Loading