Skip to content

Commit 5e5ddd8

Browse files
authored
feat: treat main branch as dev version for Operator docs (#651)
* feat: return "dev" for Operator main branch * feat: return "dev" for Operator main branch * refactor
1 parent ad7c5bd commit 5e5ddd8

File tree

4 files changed

+20
-18
lines changed

4 files changed

+20
-18
lines changed

gatsby/path.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,10 @@ function branchToVersion(repo: Repo, branch: string) {
8383
switch (repo) {
8484
case Repo.tidb:
8585
case Repo.operator: {
86+
const devBranch = repo === Repo.operator ? "main" : "master";
8687
const stable = CONFIG.docs[repo].stable;
8788
switch (branch) {
88-
case "master":
89+
case devBranch:
8990
return "dev";
9091
case stable:
9192
return "stable";

gatsby/utils.ts

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,22 @@ export function getStable(doc: Repo) {
2121
return undefined;
2222
}
2323

24-
function renameVersion(version: string, stable: string | undefined) {
25-
switch (version) {
26-
case "master":
27-
return "dev";
28-
case stable:
29-
return "stable";
30-
default:
31-
return version.replace("release-", "v");
32-
}
33-
}
34-
3524
export function renameVersionByDoc(doc: Repo, version: string) {
3625
switch (doc) {
3726
case "tidb":
3827
case "tidb-data-migration":
39-
case "tidb-in-kubernetes":
40-
return renameVersion(version, getStable(doc));
28+
case "tidb-in-kubernetes": {
29+
const devBranch = doc === "tidb-in-kubernetes" ? "main" : "master";
30+
const stable = getStable(doc);
31+
switch (version) {
32+
case devBranch:
33+
return "dev";
34+
case stable:
35+
return "stable";
36+
default:
37+
return version.replace("release-", "v");
38+
}
39+
}
4140
case "tidbcloud":
4241
return;
4342
}

src/shared/resources.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ export const TIDB_ZH_VERSIONS = CONFIG["docs"]["tidb"]["languages"]["zh"][
505505

506506
export const OP_EN_VERSIONS = CONFIG["docs"]["tidb-in-kubernetes"]["languages"][
507507
"en"
508-
]["versions"].map((d) => convertVersionName(d, OP_EN_STABLE_VERSION));
508+
]["versions"].map((d) => convertVersionName(d, OP_EN_STABLE_VERSION, "tidb-in-kubernetes"));
509509

510510
export const CLOUD_EN_VERSIONS = [];
511511

src/shared/utils/index.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,10 @@ function branchToVersion(repo: Repo, branch: string) {
184184
switch (repo) {
185185
case Repo.tidb:
186186
case Repo.operator: {
187+
const devBranch = repo === Repo.operator ? "main" : "master";
187188
const stable = CONFIG.docs[repo].stable;
188189
switch (branch) {
189-
case "master":
190+
case devBranch:
190191
return "dev";
191192
case stable:
192193
return "stable";
@@ -214,9 +215,10 @@ export const AllVersion = Object.keys(CONFIG.docs).reduce((acc, val) => {
214215
return acc;
215216
}, {} as Record<Repo, Record<Locale, (string | null)[]>>);
216217

217-
export function convertVersionName(version: string, stable: string) {
218+
export function convertVersionName(version: string, stable: string, repo?: string) {
219+
const devBranch = repo === "tidb-in-kubernetes" ? "main" : "master";
218220
switch (version) {
219-
case "master":
221+
case devBranch:
220222
return "dev";
221223
case stable:
222224
return "stable";

0 commit comments

Comments
 (0)