Skip to content

Conversation

@sharadregoti
Copy link
Contributor

@sharadregoti sharadregoti commented Nov 11, 2025

PR Type

Documentation


Description

  • Add 5.10.1 Dashboard release notes

  • Add 5.10.1 Gateway release notes

  • Update release overview to 5.10.1

  • Include dependencies, downloads, changelog


Diagram Walkthrough

flowchart LR
  ovw["overview.mdx metadata"] -- "latest -> 5.10.1" --> dash["dashboard.mdx 5.10.1 notes"]
  ovw -- "latest -> 5.10.1" --> gw["gateway.mdx 5.10.1 notes"]
  dash -- "dependencies, downloads, changelog" --> dashc["dashboard changes"]
  gw -- "dependencies, downloads, changelog" --> gwc["gateway changes"]
Loading

File Walkthrough

Relevant files
Documentation
dashboard.mdx
New Dashboard 5.10.1 release notes and changelog                 

developer-support/release-notes/dashboard.mdx

  • Add 5.10.1 release notes section.
  • Include dependencies matrix and 3rd-party tools.
  • Add downloads and upgrade instructions.
  • Document changed, added, and fixed items via accordions.
+98/-0   
gateway.mdx
New Gateway 5.10.1 release notes and fixes                             

developer-support/release-notes/gateway.mdx

  • Add 5.10.1 release notes section.
  • Include compatibility matrix and dependencies.
  • Provide downloads, source tarball, and upgrade link.
  • Detail changed and fixed items via accordions.
+119/-0 
overview.mdx
Update overview metadata to 5.10.1 versions                           

developer-support/release-notes/overview.mdx

  • Update latest Dashboard to 5.10.1 with docker link.
  • Update latest Gateway to 5.10.1 with docker and tag links.
+7/-7     

@github-actions
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

Placeholder Dates

The dashboard release notes list "Release Date xx 2025" and reference 5.10.1; confirm and replace placeholders with the actual release date to avoid publishing incomplete metadata.

#### Release Date xx 2025

#### Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.1).

#### Breaking Changes
Links/Anchors

Internal anchors like #Changelog-v5.10.1 and #upgrading-tyk should be validated; ensure target headings/ids exist and the case matches to prevent broken in-page links.

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.1).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.10.1"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 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 |
|        | EDP v1.14.1       | EDP all versions |
|        | Pump v1.13.0      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.10.1"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.10.1"></a>

If you are upgrading to 5.10.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 
Date Consistency

Overview shows latest version 5.10.1 but retains date 13/10/2025 while gateway notes list 29 October 2025 and dashboard date is placeholder; align dates across overview and respective product pages.

"latest": "5.10.1",
"releaseNotesPath": "developer-support/release-notes/dashboard",
"lts": "5.8.7",
"latestData": {
  "name": "5.10.1",
  "date": "13/10/2025",
  "docker": "https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=1&name=v5.10.1"
}

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Replace placeholder date

Replace the placeholder release date with the actual date to avoid publishing
incomplete or misleading release notes. Ensure consistency with the overview and
other product release dates.

developer-support/release-notes/dashboard.mdx [25]

-#### Release Date xx 2025
+#### Release Date 29 October 2025
Suggestion importance[1-10]: 7

__

Why: Correctly replacing the placeholder xx 2025 with the actual date improves accuracy and avoids confusion; the improved code matches the gateway date used elsewhere in the PR.

Medium
Synchronize release date values

Update the dashboard release date to match the dashboard notes once finalized;
currently the dashboard page uses a placeholder date while this overview shows
13/10/2025. Keep dates consistent across files to avoid user confusion.

developer-support/release-notes/overview.mdx [16-19]

 "latestData": {
     "name": "5.10.1",
-    "date": "13/10/2025",
+    "date": "29/10/2025",
     "docker": "https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=1&name=v5.10.1"
   }
Suggestion importance[1-10]: 7

__

Why: Ensuring the overview date matches the finalized dashboard release date prevents inconsistencies; the edit is correct and improves coherence across release notes.

Medium
General
Align Go naming consistently

Use consistent naming for the Go language to match other documents and the gateway
notes, preventing confusion and broken cross-references. Replace "GoLang" with "Go".

developer-support/release-notes/dashboard.mdx [53]

-| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 |
+| [Go](https://go.dev/dl/)              | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 |
Suggestion importance[1-10]: 5

__

Why: Changing GoLang to Go improves consistency with other files (gateway.mdx uses Go) and standard naming; it's a minor but accurate stylistic fix.

Low

@sharadregoti
Copy link
Contributor Author

Approved

@ilijabojanovic ilijabojanovic enabled auto-merge (squash) November 19, 2025 18:42
@ilijabojanovic ilijabojanovic self-requested a review November 19, 2025 18:42
@ilijabojanovic ilijabojanovic enabled auto-merge (squash) November 19, 2025 18:59
@buger buger disabled auto-merge November 19, 2025 19:20
@buger buger merged commit 3ea2f85 into main Nov 19, 2025
7 checks passed
@ilijabojanovic
Copy link
Member

/release to release-5.10

@github-actions
Copy link

❌ Cherry-pick failed. Please check the workflow logs.

@buger
Copy link
Member

buger commented Nov 19, 2025

/release to release-5.10

buger added a commit that referenced this pull request Nov 19, 2025
* Fixes

* Fixes

* Update gateway.mdx

* Fixes

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Apply suggestions from code review

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com>
(cherry picked from commit 3ea2f85)
@github-actions
Copy link

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

buger added a commit that referenced this pull request Nov 19, 2025
…md (#925)

[TT-15982] 5.10.1 RNs Gateway and Dashboard.md (#925)

* Fixes

* Fixes

* Update gateway.mdx

* Fixes

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update dashboard.mdx

* Update gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Update developer-support/release-notes/gateway.mdx

* Apply suggestions from code review

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: JoanCamosTyk <157505463+JoanCamosTyk@users.noreply.github.com>
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.

6 participants