Skip to content

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Sep 28, 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 Helm Charts 4.0.1 release notes

  • Detail tested/compatible dependencies matrix

  • Provide upgrade and downloads sections

  • State no changes, no deprecations


Diagram Walkthrough

flowchart LR
  RN["helm-chart.md release notes"] --> V401["Add 4.0.1 section"]
  V401 --> DEPS["Dependencies matrix"]
  V401 --> UPG["Upgrade instructions"]
  V401 --> DL["Downloads links"]
  V401 --> CL["Changelog: no changes"]
Loading

File Walkthrough

Relevant files
Documentation
helm-chart.md
Introduce Helm Charts v4.0.1 notes                                             

tyk-docs/content/developer-support/release-notes/helm-chart.md

  • Add 4.0.1 release notes section
  • Include tested/compatible dependencies table
  • Add upgrade commands and download links
  • Note no changes, no deprecations, no breaking changes
+47/-0   

Copy link
Contributor

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

@JoanCamosTyk JoanCamosTyk changed the title Update helm-chart.md [TT-15864] Charts RNs 4.0.1.md Sep 28, 2025
@github-actions github-actions bot changed the title [TT-15864] Charts RNs 4.0.1.md Update helm-chart.md Sep 28, 2025
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 listed as 'xx' and should be replaced with the actual release date for 4.0.1 to avoid ambiguity.

#### Release Date xx
Compatibility Claims

The statement about compatibility with Gateway/Dashboard versions should ideally reference or link to corresponding product release notes; also verify that v5.10.0 (latest) and v5.8.6 (LTS) are correct at publish time.

#### Release Highlights
Tyk Charts 4.0.1 is a version alignment release that ensures compatibility with Tyk Gateway and Dashboard v5.10.0 (latest) and v5.8.6 (LTS). No functional changes have been implemented in this release.

#### Breaking Changes
Dependency Matrix Accuracy

Validate tested/compatible versions, especially Kubernetes up to 1.32.x and Helm 3.14.x; ensure these versions are actually CI-validated and supported, and consider adding minimum Kubernetes version per chart if applicable.

##### 3rd Party Dependencies & Tools
| Third Party Dependency  | Tested Versions  | Compatible Versions  | Comments | 
| ------------------------| ---------------- | -------------------- | -------- | 
| [Kubernetes](https://kubernetes.io)   | 1.26.x, 1.27.x, 1.28.x, 1.29.x, 1.30.x, 1.31.x, 1.32.x | 1.19+ | | 
| [Helm](https://helm.sh)               | 3.14.x              | 3.x  | | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x  | 5.x, 6.x, 7.x | |
| [Valkey](https://valkey.io/download/) | 7.2.x, 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 | Used by Tyk Dashboard, Pump, and MDCB | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x | 13.x - 17.x | Used by Tyk Dashboard, Pump, and MDCB | 

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Correct unsupported Kubernetes version

Kubernetes 1.32 is not released as of the stated dates; listing it as tested can
mislead users and break CI validations. Remove 1.32.x from the tested versions to
reflect realistic testing coverage.

tyk-docs/content/developer-support/release-notes/helm-chart.md [41]

-| [Kubernetes](https://kubernetes.io)   | 1.26.x, 1.27.x, 1.28.x, 1.29.x, 1.30.x, 1.31.x, 1.32.x | 1.19+ | |
+| [Kubernetes](https://kubernetes.io)   | 1.26.x, 1.27.x, 1.28.x, 1.29.x, 1.30.x, 1.31.x | 1.19+ | |
Suggestion importance[1-10]: 7

__

Why: Removing 1.32.x from tested Kubernetes versions is likely correct given current releases and prevents misleading users; the change is precise and improves accuracy, though it's not a functional bug fix.

Medium
General
Replace placeholder release date

Replace the placeholder release date with the actual release date to avoid ambiguity
and automation failures that parse dates. Use a consistent format matching other
entries.

tyk-docs/content/developer-support/release-notes/helm-chart.md [28]

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

__

Why: Replacing #### Release Date xx with a real date improves clarity and downstream automation, but it depends on external information and is a routine documentation fix.

Low
Fix anchor ID casing

Anchor IDs are case-sensitive in many static site generators; using inconsistent
casing can break in-page links. Normalize the anchor to lowercase and align with the
pattern used elsewhere.

tyk-docs/content/developer-support/release-notes/helm-chart.md [70]

-#### Changelog {#Changelog-v4.0.1}
+#### Changelog {#changelog-v4.0.1}
Suggestion importance[1-10]: 5

__

Why: Normalizing the anchor casing to #changelog-v4.0.1 can improve intra-page link reliability; impact is moderate and context-dependent on the site generator's handling of anchors.

Low

Copy link

netlify bot commented Sep 28, 2025

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

Name Link
🔨 Latest commit 11b0d49
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68d903c0077a0a0008882934
😎 Deploy Preview https://deploy-preview-6991--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.

Copy link

netlify bot commented Sep 28, 2025

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

Name Link
🔨 Latest commit 016f2cc
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68dfc9ce93a9480008e25061
😎 Deploy Preview https://deploy-preview-6991--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.

@JoanCamosTyk JoanCamosTyk changed the title Update helm-chart.md [TT-15864] Charts RN 4.0.1.md Sep 28, 2025
---
## 4.0 Release Notes

### 4.0.1 Release Notes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: Change the date before merging.

@andyo-tyk andyo-tyk changed the title [TT-15864] Charts RN 4.0.1.md [TT-15895] Charts RN 4.0.1.md Oct 1, 2025
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.

4 participants