[DX-1813] Release Notes 5.3.10 #5973

Eopayemi · 2025-02-06T14:16:41Z

User description

For internal users - Please add a Jira DX PR ticket to the subject!

DX-1813

Preview Link

Description

Release notes for 5.3.10

Screenshots (if appropriate)

Checklist

I have added a preview link to the PR description.
I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
I have reviewed the guidelines for contributing to this repository.
I have read the technical guidelines for contributing to this repository.
Make sure you have started your change off our latest master.
For Tyk Members - Please add a Jira DX PR ticket to the subject!
For Tyk Members - I have added the appropriate release label to this PR:
- If it is for a future release, label it as future-release and specify the version (e.g., future-release, 6.0).
- If it should be merged into an older version, use the specific version label (e.g., 4.1, 5.1).
- If no label is added, it will be assumed that the PR should be merged into the latest current version (e.g., 5.5) and master.

PR Type

Documentation, Enhancement

Description

Added release notes for Tyk Dashboard v5.3.10, including highlights and changelog.
Documented dependency updates, including Golang upgrade to v1.23.
Detailed fixed issues, including a critical CVE and API authentication improvements.
Provided compatibility matrices, upgrade instructions, and download links.

Changes walkthrough 📝

Relevant files

Documentation

dashboard.md `Added Tyk Dashboard v5.3.10 release notes.` tyk-docs/content/developer-support/release-notes/dashboard.md Added release notes for Tyk Dashboard v5.3.10. Highlighted Golang upgrade to v1.23 and fixed CVE-2025-21613. Included compatibility matrix and third-party dependency details. Provided upgrade instructions and download links.	+82/-0
gateway.md `Added Tyk Gateway v5.3.10 release notes.` tyk-docs/content/developer-support/release-notes/gateway.md Added release notes for Tyk Gateway v5.3.10. Highlighted Golang upgrade to v1.23 and API authentication fix. Included compatibility matrix and third-party dependency details. Provided upgrade instructions and download links.	+76/-0

Need help?
Type /help how to ... in the comments thread for any questions about PR-Agent usage.
Check out the documentation for more information.

github-actions · 2025-02-06T14:17:56Z

PR Reviewer Guide 🔍

(Review updated until commit `ec9115b`)

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 Possible Documentation Clarity Issue The release notes mention "Users may need to adjust their setup for compatibility" after upgrading to Golang 1.23, but it does not specify what adjustments might be necessary. This could lead to confusion for users. <summary>Upgraded to Golang 1.23</summary> Tyk Dashboard now runs on Golang 1.23, bringing security and performance improvements. Key changes include unbuffered Timer/Ticker channels, removal of 3DES cipher suites, and updates to X509KeyPair handling. Users may need to adjust their setup for compatibility. </details> Possible Documentation Clarity Issue The description of the fix for the API authentication issue with redirects using "tyk://" scheme could benefit from more technical details or examples to help users understand the change and its implications. <summary>Resolved API authentication issue while handling redirects using "tyk://" Scheme</summary> This fix ensures that when API A redirects to API B using the tyk:// scheme, API B will now correctly authenticate using its own credentials, improving access control and preventing access denials. Users can now rely on the expected authentication flow without workarounds, providing a smoother experience when integrating APIs. </details>

github-actions · 2025-02-06T14:18:19Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Provide meaningful changelog details Add a meaningful summary and description in the "Changelog" section to provide users with clear insights into the fixed issues or changes in this release. tyk-docs/content/developer-support/release-notes/dashboard.md [1208-1210] -<summary>Add changelog summary</summary> +<summary>Fixed issue with API connectivity</summary> -Add changelog description +Resolved an issue where API connectivity was intermittently failing under high load conditions. Suggestion importance[1-10]: 9 __ Why: Adding a meaningful summary and description in the changelog section significantly enhances the usability of the release notes by providing users with clear and actionable insights into the fixed issues or changes. This is a critical improvement for user understanding.	High
General	Replace placeholder with actual date Replace the placeholder "xxx" in the "Release Date" section with the actual release date to ensure clarity and completeness of the release notes. tyk-docs/content/developer-support/release-notes/dashboard.md [1151] -#### Release Date xxx +#### Release Date 6 February 2025 Suggestion importance[1-10]: 8 __ Why: Replacing the placeholder "xxx" with the actual release date improves the clarity and professionalism of the release notes, ensuring users have accurate information. This is a straightforward and impactful enhancement.	Medium

netlify · 2025-02-06T14:18:43Z

✅ PS. Pls add /docs/nightly to the end of url

Name	Link
🔨 Latest commit	`88b89c8`
🔍 Latest deploy log	https://app.netlify.com/sites/tyk-docs/deploys/67ae031a58655200087f4643
😎 Deploy Preview	https://deploy-preview-5973--tyk-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2025-02-13T12:57:21Z

Persistent review updated to latest commit ec9115b

github-actions · 2025-02-13T12:57:25Z

PR Code Suggestions ✨

No code suggestions found for the PR.

…into release.5.3.10-rn

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

andyo-tyk

Don't forget to review the dependencies table - we're updating to Go 1.23 in this release.

andyo-tyk · 2025-02-13T14:33:23Z

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

+
+#### Release Highlights
+
+In this release, we upgraded the Golang version to `v1.23` and fixed a [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613]). For a comprehensive list of changes, please refer to the detaile [changelog]({{< ref "#Changelog-v5.3.10">}}) below.


Suggested change

In this release, we upgraded the Golang version to `v1.23` and fixed a [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613]). For a comprehensive list of changes, please refer to the detaile [changelog]({{< ref "#Changelog-v5.3.10">}}) below.

In this release, we upgraded the Golang version to `v1.23` and fixed a [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613]). For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.3.10">}}) below.

andyo-tyk · 2025-02-13T14:33:50Z

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

+
+| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
+| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- |
+| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |


Suggested change

| [GoLang](https://go.dev/dl/) | 1.22 | 1.22 | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |

| [GoLang](https://go.dev/dl/) | 1.23 | 1.23 | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.23 |

andyo-tyk · 2025-02-13T14:35:26Z

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

+
+| Third Party Dependency                                        | Tested Versions       | Compatible Versions   | Comments                                                                                   |
+| ------------------------------------------------------------- | --------------------- | --------------------- | ------------------------------------------------------------------------------------------ |
+| [Go](https://go.dev/dl/)                                      |  1.22 (GW)            |  1.22 (GW)            | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |


Suggested change

| [Go](https://go.dev/dl/) | 1.22 (GW) | 1.22 (GW) | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 |

| [Go](https://go.dev/dl/) | 1.23 (GW) | 1.23 (GW) | [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.23 |

5.3.10

f0810ce

Eopayemi added Documentation requires peer review 5.3.10 labels Feb 6, 2025

Eopayemi requested review from sharadregoti and andyo-tyk February 6, 2025 14:16

github-actions bot added the Review effort [1-5]: 2 label Feb 6, 2025

Eopayemi marked this pull request as draft February 6, 2025 14:19

Eopayemi and others added 6 commits February 11, 2025 13:58

Update gateway.md

04a5524

Update gateway.md

0efbdce

Update dashboard.md

db3ecc3

Update dashboard.md

84850f6

Update dashboard.md

97b1415

Fixes

210e38e

sharadregoti approved these changes Feb 13, 2025

View reviewed changes

sharadregoti marked this pull request as ready for review February 13, 2025 12:56

sharadregoti added the release-5.7 label Feb 13, 2025

github-actions bot added Review effort 2/5 and removed Review effort [1-5]: 2 labels Feb 13, 2025

sharadregoti added 2 commits February 13, 2025 18:38

Fixes

d88fa14

Merge branch 'master' of https://github.com/TykTechnologies/tyk-docs …

3e802d2

…into release.5.3.10-rn

sharadregoti force-pushed the release.5.3.10-rn branch from ec9115b to 3e802d2 Compare February 13, 2025 13:09

Update dashboard.md

da7e93a

asutosh reviewed Feb 13, 2025

View reviewed changes

tyk-docs/content/developer-support/release-notes/dashboard.md Outdated Show resolved Hide resolved

Update dashboard.md

88b89c8

andyo-tyk requested changes Feb 13, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DX-1813] Release Notes 5.3.10 #5973

[DX-1813] Release Notes 5.3.10 #5973

Eopayemi commented Feb 6, 2025 •

edited by sharadregoti

Loading

github-actions bot commented Feb 6, 2025 •

edited

Loading

github-actions bot commented Feb 6, 2025

netlify bot commented Feb 6, 2025 •

edited

Loading

github-actions bot commented Feb 13, 2025

github-actions bot commented Feb 13, 2025

andyo-tyk left a comment

andyo-tyk Feb 13, 2025

andyo-tyk Feb 13, 2025

andyo-tyk Feb 13, 2025


		#### Release Highlights

		In this release, we upgraded the Golang version to `v1.23` and fixed a [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613]). For a comprehensive list of changes, please refer to the detaile [changelog]({{< ref "#Changelog-v5.3.10">}}) below.

	\| [GoLang](https://go.dev/dl/) \| 1.22 \| 1.22 \| [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 \|
	\| [GoLang](https://go.dev/dl/) \| 1.23 \| 1.23 \| [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.23 \|

	\| [Go](https://go.dev/dl/) \| 1.22 (GW) \| 1.22 (GW) \| [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.22 \|
	\| [Go](https://go.dev/dl/) \| 1.23 (GW) \| 1.23 (GW) \| [Go plugins]({{< ref "plugins/supported-languages/golang" >}}) must be built using Go 1.23 \|

[DX-1813] Release Notes 5.3.10 #5973

Are you sure you want to change the base?

[DX-1813] Release Notes 5.3.10 #5973

Conversation

Eopayemi commented Feb 6, 2025 • edited by sharadregoti Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!

Preview Link

Description

Screenshots (if appropriate)

Checklist

PR Type

Description

Changes walkthrough 📝

github-actions bot commented Feb 6, 2025 • edited Loading

PR Reviewer Guide 🔍

(Review updated until commit ec9115b)

github-actions bot commented Feb 6, 2025

PR Code Suggestions ✨

netlify bot commented Feb 6, 2025 • edited Loading

✅ PS. Pls add /docs/nightly to the end of url

github-actions bot commented Feb 13, 2025

github-actions bot commented Feb 13, 2025

PR Code Suggestions ✨

andyo-tyk left a comment

Choose a reason for hiding this comment

andyo-tyk Feb 13, 2025

Choose a reason for hiding this comment

andyo-tyk Feb 13, 2025

Choose a reason for hiding this comment

andyo-tyk Feb 13, 2025

Choose a reason for hiding this comment

Eopayemi commented Feb 6, 2025 •

edited by sharadregoti

Loading

github-actions bot commented Feb 6, 2025 •

edited

Loading

(Review updated until commit `ec9115b`)

netlify bot commented Feb 6, 2025 •

edited

Loading