Skip to content

Conversation

@buger
Copy link
Member

@buger buger commented Nov 26, 2025

User description

📚 Documentation Merge Summary

This PR contains automatically merged documentation from multiple branches.

Triggered by:

Deployment Details:

  • Generated from: branches-config.json
  • Run ID: 19707994535
  • Subfolder: (root deployment)
  • Timestamp: $(date)

Changes Include:

  • ✅ Merged documentation from multiple branches
  • ✅ Generated unified docs.json configuration
  • ✅ Updated assets and content structure
  • ✅ Cleaned up outdated version folders

🚦 This PR will be processed by merge queue to ensure proper validation and ordering.

Previous deployment PRs have been automatically closed to prevent conflicts.


PR Type

Documentation


Description

  • Add Helm Charts 4.1.0 release notes

  • Update overview to point to 4.1.0

  • Include dependencies, downloads, changelog

  • Clarify no breaking or deprecations


Diagram Walkthrough

flowchart LR
  notes["Add 4.1.0 section in helm-chart.mdx"]
  deps["Dependencies, downloads, changelog added"]
  compat["Align with Tyk 5.8.8 LTS"]
  features["Tolerations + Topology Spread support"]
  overview["Update overview.mdx latest to 4.1.0"]
  notes -- "new release entry" --> deps
  deps -- "documents" --> features
  notes -- "mentions" --> compat
  overview -- "links and label updated" --> notes
Loading

File Walkthrough

Relevant files
Documentation
helm-chart.mdx
Introduce Helm Charts 4.1.0 release notes                               

nightly/developer-support/release-notes/helm-chart.mdx

  • Add 4.1.0 release notes section.
  • Document compatibility with Tyk 5.8.8 LTS.
  • Provide dependencies, upgrade, downloads.
  • Add changelog: tolerations and topology spread.
+68/-0   
overview.mdx
Refresh overview to reference 4.1.0                                           

nightly/developer-support/release-notes/overview.mdx

  • Update latest Helm Charts to 4.1.0.
  • Adjust latestData name and tag URL.
  • Keep release date unchanged.
+3/-3     

Generated from branches-config.json at

- Merged documentation from multiple branches
- Generated unified docs.json
- Updated assets and content structure
@buger buger added auto-deployment automated documentation Improvements or additions to documentation labels Nov 26, 2025
@buger buger enabled auto-merge (squash) November 26, 2025 14:58
@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

923 - Partially compliant

Compliant requirements:

  • Add Helm Charts 4.1.0 release notes
  • Update overview to latest 4.1.0 metadata
  • Provide downloads and dependencies table
  • Clarify no functional or breaking changes
  • Include compatibility note with Tyk 5.8.8 LTS
  • Provide upgrade steps
  • Refresh links (tag and ArtifactHub)

Non-compliant requirements:

Requires further human verification:

  • Validate that the release date and links (ArtifactHub entries and tag URL) resolve correctly once deployed
  • Confirm that the “features” called out (tolerations and topology spread) match underlying chart values and docs elsewhere
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Possible Date Mismatch

The latest entry keeps the date as 26/09/2025 while the 4.1.0 notes list 26th November 2025. Confirm the correct release date for 4.1.0 and align both places.

"date": "26/09/2025",
"docker": "",
External Links Validation

Ensure all new links (dashboard 5.8.8 anchor, changelog anchor, ArtifactHub package URLs, source tarball) resolve correctly in the nightly context and after publish.

Tyk Charts 4.1.0 is a version alignment release that ensures compatibility with the most recent Tyk LTS release [5.8.8](/nightly/developer-support/release-notes/dashboard#588-release-notes). Moreover, this release includes support for Kubernetes tolerations across all Tyk workloads and a new configuration option for Pod Topology Spread Constraints.

For more information, please refer to the [changelog](/nightly/#Changelog-v4.1.0) below.

#### Breaking Changes
This release has no breaking changes.

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

##### 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 | 

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

#### Deprecations
There are no deprecations in this release.

#### Upgrade instructions
You can use helm upgrade to upgrade your release

```bash
helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
helm repo update

helm upgrade [RELEASE_NAME] tyk-helm/[CHART_NAME]

Downloads


</details>

</td></tr>
</table>

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix mismatched release date

The date shows September while the new release notes state 26th November 2025. Align
the date field to the correct release date to keep metadata consistent.

nightly/developer-support/release-notes/overview.mdx [120-123]

 "latestData": {
     "name": "4.1.0",
-    "date": "26/09/2025",
+    "date": "26/11/2025",
     "docker": "",
     "tag": "https://github.com/TykTechnologies/tyk-charts/releases/tag/v4.1.0"
   }
Suggestion importance[1-10]: 8

__

Why: This corrects a clear inconsistency between the new release notes (26th November 2025) and the overview date (26/09/2025); accurate metadata is important and the fix matches the PR context.

Medium
Fix broken internal anchor link

The internal anchor #588-release-notes likely mismatches the actual section ID
format and may 404. Replace with the correct anchor slug used on the dashboard
release notes page to avoid a broken link.

nightly/developer-support/release-notes/helm-chart.mdx [25]

-Tyk Charts 4.1.0 is a version alignment release that ensures compatibility with the most recent Tyk LTS release [5.8.8](/nightly/developer-support/release-notes/dashboard#588-release-notes). Moreover, this release includes support for Kubernetes tolerations across all Tyk workloads and a new configuration option for Pod Topology Spread Constraints.
+Tyk Charts 4.1.0 is a version alignment release that ensures compatibility with the most recent Tyk LTS release [5.8.8](/nightly/developer-support/release-notes/dashboard#release-5-8-8). Moreover, this release includes support for Kubernetes tolerations across all Tyk workloads and a new configuration option for Pod Topology Spread Constraints.
Suggestion importance[1-10]: 5

__

Why: The link anchor #588-release-notes may be incorrect and could 404, but the suggested replacement #release-5-8-8 is speculative without confirmation of the target page's IDs; impact is moderate but uncertainty lowers confidence.

Low
Possible issue
Correct unsupported tested version

Kubernetes 1.32 is not released as of November 2025 and listing it as tested is
misleading. Remove 1.32.x from the tested versions to prevent inaccurate
compatibility claims.

nightly/developer-support/release-notes/helm-chart.mdx [38]

-| [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]: 4

__

Why: The table line exists and change is straightforward, but the claim that Kubernetes 1.32 isn't released as of Nov 2025 is uncertain; without authoritative reference this could be incorrect, so moderate-low score.

Low

@buger buger merged commit d85ac5a into production Nov 26, 2025
5 checks passed
@buger buger deleted the docs-merge-458 branch November 26, 2025 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants