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 5.8.7 Gateway release notes section

  • Include compatibility and dependencies matrices

  • Provide downloads and upgrade references

  • Stub changelog and confirm no breaking changes


Diagram Walkthrough

flowchart LR
  rel["Add 5.8.7 Release Notes"]
  deps["Dependencies & Compatibility Matrix"]
  upg["Upgrade Instructions Link"]
  dl["Downloads (Docker, Helm, Source)"]
  chg["Changelog Anchor for 5.8.7"]

  rel -- "details" --> deps
  rel -- "guidance" --> upg
  rel -- "artifacts" --> dl
  rel -- "placeholder" --> chg
Loading

File Walkthrough

Relevant files
Documentation
gateway.md
Add Gateway 5.8.7 release notes content                                   

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

  • Introduce 5.8.7 release notes section.
  • Add compatibility matrix and third-party dependencies.
  • Add upgrade instructions and downloads links.
  • Create changelog anchor with placeholder "Changed".
+59/-0   

@github-actions
Copy link
Contributor

⚠️ Deploy preview for PR #7065 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 Date

The release date is a placeholder ('xx October 2025'); confirm and replace with the actual release date before publishing.

#### Release Date xx October 2025

#### Release Highlights
Incomplete Changelog

The 5.8.7 changelog section is empty under 'Changed'; populate with actual changes or clarify if there were none.

#### Changelog {#Changelog-v5.8.7}

##### Changed
Version Consistency

Verify compatibility matrix and links (Helm chart version, Operator, MDCB, etc.) match actual released versions; some entries mix 'Recommended' and 'Backwards Compatibility' ambiguously.

| Gateway Version | Recommended Releases | Backwards Compatibility |
|----     |---- |---- |
| 5.8.7   | MDCB v2.8.5     | MDCB v2.8.5 |
|         | Operator v1.2.0 | Operator v0.17 |
|         | Sync v2.1.4     | Sync v2.1.1 |
|         | Helm Chart v4.1 | Helm all versions |
|         | EDP v1.14.1     | EDP all versions |
|         | Pump v1.12.2    | Pump all versions |
|         | TIB (if using standalone) v1.7.0 | TIB all versions |

@github-actions
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Clarify Go version semantics

Verify and correct the Go version to a valid released version (e.g., 1.24.x) to
prevent users from building against a non-existent or ambiguous toolchain. If
minor/patch is required for plugins, specify it explicitly.

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

-| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24 |
+| [Go](https://go.dev/dl/)                                     | 1.24.x | 1.24.x | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.24.x |
Suggestion importance[1-10]: 7

__

Why: Suggesting explicit version semantics (1.24.x) prevents ambiguity and potential user confusion; it’s accurate and useful but not critical.

Medium
Replace placeholder release date

Replace the placeholder date with the actual release date to avoid publishing
ambiguous information. Leaving placeholders can mislead users and reduce
documentation credibility.

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

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

__

Why: Replacing the placeholder date with the actual release date improves accuracy and professionalism, but it's a straightforward editorial fix rather than a functional change.

Low
Possible issue
Fix malformed compatibility table

Ensure the first column is populated on each row to keep the Markdown table
structurally valid and accessible. Empty cells under "Gateway Version" can render
inconsistently; duplicate the version for clarity.

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

 | Gateway Version | Recommended Releases | Backwards Compatibility |
-|----     |---- |---- |
-| 5.8.7   | MDCB v2.8.5     | MDCB v2.8.5 |
-|         | Operator v1.2.0 | Operator v0.17 |
-|         | Sync v2.1.4     | Sync v2.1.1 |
-|         | Helm Chart v4.1 | Helm all versions |
-|         | EDP v1.14.1     | EDP all versions |
-|         | Pump v1.12.2    | Pump all versions |
-|         | TIB (if using standalone) v1.7.0 | TIB all versions |
+|----|----|----|
+| 5.8.7 | MDCB v2.8.5 | MDCB v2.8.5 |
+| 5.8.7 | Operator v1.2.0 | Operator v0.17 |
+| 5.8.7 | Sync v2.1.4 | Sync v2.1.1 |
+| 5.8.7 | Helm Chart v4.1 | Helm all versions |
+| 5.8.7 | EDP v1.14.1 | EDP all versions |
+| 5.8.7 | Pump v1.12.2 | Pump all versions |
+| 5.8.7 | TIB (if using standalone) v1.7.0 | TIB all versions |
Suggestion importance[1-10]: 7

__

Why: Filling empty first-column cells enhances Markdown table rendering and accessibility; it’s a valid improvement with moderate impact on readability and consistency.

Medium

@netlify
Copy link

netlify bot commented Oct 15, 2025

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

Name Link
🔨 Latest commit 98681b6
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68ef92e39360ba0008b2240f
😎 Deploy Preview https://deploy-preview-7065--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 4fde5d1
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68fba24a98dfcb0008f7c043
😎 Deploy Preview https://deploy-preview-7065--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