Skip to content

Conversation

sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Aug 18, 2025

PR Type

Enhancement, Documentation


Description

  • Promote v5.9 as latest release

  • Add internal v5.8, deprecate v5.7/5.6

  • Link v5.7 and v5.6 to external docs

  • Keep nightly and older externals unchanged


Diagram Walkthrough

flowchart LR
  A["branches-config.json"] -- "update latest" --> B["v5.9: branch/source/target/label"]
  A -- "add version" --> C["v5.8: branch/source/target/label"]
  A -- "externalize" --> D["v5.7 -> external URL"]
  A -- "externalize" --> E["v5.6 -> external URL"]
  A -- "unchanged" --> F["Nightly, older versions"]
Loading

File Walkthrough

Relevant files
Configuration changes
branches-config.json
Update docs versions: 5.9 latest, 5.8 added, 5.7/5.6 external

branches-config.json

  • Set release-5.9 as latest with folders and label
  • Add release-5.8 internal entry with folders and label
  • Convert v5.7 and v5.6 to external links
  • Preserve nightly and existing external versions
+18/-16 

Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Consistency

Ensure the new 'v5.9' entry matches downstream tooling expectations (keys like 'branch', 'sourceFolder', 'targetFolder', 'label') and ordering does not affect consumers that may assume 'latest' is first.

  "branch": "release-5.9",
  "isLatest": true,
  "sourceFolder": "5.9-source",
  "targetFolder": "5.9",
  "label": "v5.9 (latest)"
},
External URLs

Validate that the external documentation URLs for v5.7 and v5.6 are correct and reachable, and that any navigation logic correctly handles 'isExternal' entries without 'branch/sourceFolder/targetFolder'.

  "isExternal": true,
  "externalUrl": "https://tyk.io/docs/5.7",
  "label": "v5.7"
},
{
  "isExternal": true,
  "externalUrl": "https://tyk.io/docs/5.6",
  "label": "v5.6"
},
Backward Compatibility

Confirm that removing internal configs for v5.7/v5.6 and introducing v5.8 as internal does not break build scripts or redirects that previously relied on '5.7-source'/'5.6-source'.

{
  "branch": "release-5.8",
  "isLatest": false,
  "isMain": false,
  "sourceFolder": "5.8-source",
  "targetFolder": "5.8",
  "label": "v5.8"
},

Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Validate latest flag and ordering

Ensure the ordering keeps the latest GA first, then sequential prior versions. Also,
double-check that release-5.9 actually exists and that isLatest: true is unique
across entries to avoid build logic conflicts.

branches-config.json [1-105]

+{
+  "versions": [
+    {
+      "branch": "release-5.9",
+      "isLatest": true,
+      "sourceFolder": "5.9-source",
+      "targetFolder": "5.9",
+      "label": "v5.9 (latest)"
+    },
+    {
+      "branch": "main",
+      "isLatest": false,
+      "isMain": true,
+      "sourceFolder": "nightly-source",
+      "targetFolder": "nightly",
+      "label": "Nightly"
+    },
+    {
+      "branch": "release-5.8",
+      "isLatest": false,
+      "isMain": false,
+      "sourceFolder": "5.8-source",
+      "targetFolder": "5.8",
+      "label": "v5.8"
+    },
+    {
+      "isExternal": true,
+      "externalUrl": "https://tyk.io/docs/5.7",
+      "label": "v5.7"
+    },
+    {
+      "isExternal": true,
+      "externalUrl": "https://tyk.io/docs/5.6",
+      "label": "v5.6"
+    },
+    {
+      "isExternal": true,
+      "externalUrl": "https://tyk.io/docs/5.5",
+      "label": "v5.5"
+    }
+  ],
+  "buildConfig": {
+    "docsDir": "."
+  }
+}
 
-
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly aligns with the updated JSON structure and emphasizes unique isLatest and proper ordering, which are reasonable checks but mostly verification rather than concrete fixes.

Low
Prevent misclassification of external entries

Add an explicit isMain: false to non-main release entries only and avoid setting
isMain on external entries to prevent consumers from misidentifying them as build
sources. Verify no external entries include branch, sourceFolder, or targetFolder.

branches-config.json [10-40]

 {
   "versions": [
     ...
     {
       "branch": "main",
       "isLatest": false,
       "isMain": true,
       "sourceFolder": "nightly-source",
       "targetFolder": "nightly",
       "label": "Nightly"
     },
+    {
+      "branch": "release-5.8",
+      "isLatest": false,
+      "isMain": false,
+      "sourceFolder": "5.8-source",
+      "targetFolder": "5.8",
+      "label": "v5.8"
+    },
+    {
+      "isExternal": true,
+      "externalUrl": "https://tyk.io/docs/5.7",
+      "label": "v5.7"
+    },
+    {
+      "isExternal": true,
+      "externalUrl": "https://tyk.io/docs/5.6",
+      "label": "v5.6"
+    },
     ...
   ],
   "buildConfig": {
     "docsDir": "."
   }
 }
Suggestion importance[1-10]: 5

__

Why: It reinforces correct use of isMain and absence of build fields on external entries, matching the PR content; however, it's largely advisory and reflects existing correct state.

Low
Add trailing newline at EOF

Ensure the file ends with a trailing newline to avoid issues with linters and
certain CI tools that enforce POSIX-style newlines at EOF.

branches-config.json [105]

+}
 
-
Suggestion importance[1-10]: 3

__

Why: Minor formatting reminder; the diff already shows the closing brace added, and the impact is small though sometimes useful for linters.

Low

@sharadregoti sharadregoti merged commit d254849 into main Aug 18, 2025
7 checks passed
@buger
Copy link
Member

buger commented Aug 18, 2025

/release to release-5.8

@buger
Copy link
Member

buger commented Aug 18, 2025

/release to release-5.9

Copy link

ℹ️ Cherry-pick skipped: no changes needed in target branch.

buger pushed a commit that referenced this pull request Aug 18, 2025
(cherry picked from commit d254849)
Copy link

✅ Cherry-pick successful. A PR was created and auto-merged (if allowed): #664

@sharadregoti
Copy link
Contributor Author

/release to release-5.9

Copy link

ℹ️ Cherry-pick skipped: no changes needed in target branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants