Skip to content

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Oct 15, 2025

User description

Contributor checklist

  • Reviewed PR Code suggestions and updated accordingly
  • Tyklings: Labled the PR with the relevant releases
  • Tyklings: Added Jira DX PR ticket to the subject

New Contributors



PR Type

Documentation


Description

  • Add Gateway 5.10.1 release notes section

  • Provide compatibility and dependencies tables

  • Include downloads and upgrade guidance

  • Add changelog anchor for 5.10.1


Diagram Walkthrough

flowchart LR
  RN["Gateway release notes page"] --> S5101["New 5.10.1 section"]
  S5101 --> HL["Highlights & no breaking changes"]
  S5101 --> DEP["Dependencies & compatibility matrix"]
  S5101 --> UPG["Upgrade instructions link"]
  S5101 --> DLD["Downloads (Docker, Helm, source)"]
  S5101 --> CL["Changelog anchor"]
Loading

File Walkthrough

Relevant files
Documentation
gateway.md
Introduce Gateway 5.10.1 release notes                                     

tyk-docs/content/developer-support/release-notes/gateway.md

  • Add 5.10.1 release notes section.
  • Add compatibility matrix and 3rd-party dependencies.
  • Add upgrade, downloads, and changelog anchor.
  • Note Helm charts default to LTS.
+60/-0   

@github-actions
Copy link
Contributor

⚠️ Deploy preview for PR #7066 did not become live after 3 attempts.
Please check Netlify or try manually: Preview URL

@github-actions
Copy link
Contributor

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

Placeholder Dates

The release date is a placeholder ("xx October 2025"). Replace with the actual date before publishing.

#### Release Date xx October 2025
Version Mismatch

Compatibility matrix row labels show "5.10.0" while this section is for 5.10.1; verify and adjust component versions and headings accordingly.

| Gateway Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|---- |
| 5.10.0 | MDCB v2.8.5       | MDCB v2.8.5 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.4       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | Pump v1.12.2      | Pump all versions |
Dependency Accuracy

Go 1.24 requirement and Redis/Valkey versions look unusual/new; confirm tested/compatible versions and plugin build note before release.

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [Go](https://go.dev/dl/)               | 1.24                   |  1.24  | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)    | 6.2.x, 7.x, 7.4.x      | 6.2.x, 7.x, 7.4.x      | | 
| [Valkey](https://valkey.io/download/)  | 7.2.x, 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x  | v3.0.x | Supported by [Tyk OAS]({{< ref "api-management/gateway-config-tyk-oas" >}}) |

@github-actions
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Correct version in compatibility matrix

The matrix header lists "Gateway Version" as 5.10.0 while this section is for
5.10.1, which can mislead users. Update the version row to 5.10.1 or explicitly
indicate applicability to 5.10.1.

tyk-docs/content/developer-support/release-notes/gateway.md [62-69]

 | Gateway Version | Recommended Releases | Backwards Compatibility |
 |--------|-------------------|---- |
-| 5.10.0 | MDCB v2.8.5       | MDCB v2.8.5 |
+| 5.10.1 | MDCB v2.8.5       | MDCB v2.8.5 |
 |        | Operator v1.2.0   | Operator v0.17 |
 |        | Sync v2.1.4       | Sync v2.1.0 |
 |        | Helm Chart v4.0   | Helm all versions |
 |        | Pump v1.12.2      | Pump all versions |
Suggestion importance[1-10]: 7

__

Why: The section is for 5.10.1 but the matrix starts with 5.10.0, which can mislead users; updating to 5.10.1 is accurate and improves clarity.

Medium
Replace placeholder release date

Replace the placeholder release date with the actual date to avoid publishing with
incomplete metadata. Ensure it matches the established date format used elsewhere in
the document.

tyk-docs/content/developer-support/release-notes/gateway.md [48]

-#### Release Date xx October 2025
+#### Release Date 15th October 2025
Suggestion importance[1-10]: 6

__

Why: The date is clearly a placeholder (xx October 2025) and should be updated before release; the fix is accurate and improves correctness, though not critical.

Low
General
Fix nested code block formatting

The fenced code block is indented under a list, which can break rendering in some
Markdown engines. Use standard fenced code without extra indentation or specify the
language on the same fence line.

tyk-docs/content/developer-support/release-notes/gateway.md [91-95]

 - [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.10.1)
-  - ```bash
-    docker pull tykio/tyk-gateway:v5.10.1
-    ```
 
+  ```bash
+  docker pull tykio/tyk-gateway:v5.10.1
+  ```
+
Suggestion importance[1-10]: 5

__

Why: Adjusting the fenced code block indentation can improve Markdown rendering in some engines; it's a minor formatting improvement and the proposed code matches the context.

Low

@netlify
Copy link

netlify bot commented Oct 15, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit 79e0b0f
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68ef95b21031fb000838f8ee
😎 Deploy Preview https://deploy-preview-7066--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Oct 15, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit f067e9e
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68ef9663c8ebea0008dd825d
😎 Deploy Preview https://deploy-preview-7066--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Oct 15, 2025

PS. Add to the end of url /docs/nightly

Name Link
🔨 Latest commit c8b640b
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68f772159cf722000868b872
😎 Deploy Preview https://deploy-preview-7066--tyk-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

3 participants