Skip to content

Conversation

JoanCamosTyk
Copy link
Contributor

@JoanCamosTyk JoanCamosTyk commented Sep 26, 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 1.12.2 release notes skeleton

  • Include dependencies compatibility matrix

  • Provide upgrade and download guidance

  • Add changelog anchor for 1.12.2


Diagram Walkthrough

flowchart LR
  notes["Pump Release Notes"]
  v1122["Section: 1.12.2"]
  deps["Dependencies Matrix"]
  upgrade["Upgrade Instructions"]
  downloads["Downloads (Docker, Source)"]
  changelog["Changelog Anchor"]

  notes -- "new section" --> v1122
  v1122 -- "lists" --> deps
  v1122 -- "guides" --> upgrade
  v1122 -- "links" --> downloads
  v1122 -- "adds" --> changelog
Loading

File Walkthrough

Relevant files
Documentation
pump.md
Add comprehensive 1.12.2 release notes section                     

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

  • Add 1.12.2 release notes section.
  • Add third-party dependencies table and guidance.
  • Add upgrade instructions and download links.
  • Introduce changelog anchor and placeholders.
+45/-0   

Copy link
Contributor

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

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 section shows '#### Release xx' but does not specify an actual release date, which may confuse readers and should be finalized before publishing.

#### Release xx

#### Release Highlights
Incomplete Changelog

The 'Changelog' section is created but empty (only a 'Fixed' header). Ensure actual entries are added or clarify 'No changes' to avoid an empty section.

##### Fixed

### 1.12.1 Release Notes
Compatibility Matrix Clarity

The dependencies matrix mixes 'tested' vs 'compatible' versions but lacks notes on minimum supported versions and EOL caveats; consider clarifying ranges (e.g., Redis 7.2/7.4), and whether MongoDB 4.4 is still supported.

| Third Party Dependency                                    | Tested Versions   | Compatible Versions      | Comments                   |
| --------------------------------------------------------- | ----------------- | ------------------------ | -------------------------- |
| [MongoDB](https://www.mongodb.com/try/download/community) | 5.x, 6.x, and 7.0 | 4.4.x, 5.x, 6.x, and 7.0 | Used by Tyk Pump and Tyk Dashboard      |
| [PostgreSQL](https://www.postgresql.org/download/)        | 13.x - 17.x    | 13.x - 17.x              | Used by Tyk Pump and Tyk Dashboard      |
| [Redis](https://redis.io/download/)                       | 6.x - 7.0         | 6.x - 7.x                | Used by all Tyk components |

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.

Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix list code block formatting

Avoid nested list code fences inside a list item which can break formatting; indent
the fenced block correctly under the list item. Also remove empty query parameters
from the Docker Hub URL to reduce fragility.

tyk-docs/content/developer-support/release-notes/pump.md [60-65]

 #### Downloads
-- [Docker Image v1.12.2](https://hub.docker.com/r/tykio/tyk-pump-docker-pub/tags?page=&page_size=&ordering=&name=v1.12.2)
-  - ```bash
-    docker pull tykio/tyk-pump-docker-pub:v1.12.2
-    ```
+- [Docker Image v1.12.2](https://hub.docker.com/r/tykio/tyk-pump-docker-pub/tags?name=v1.12.2)
+
+  ```bash
+  docker pull tykio/tyk-pump-docker-pub:v1.12.2
+  ```
 - Source code tarball for OSS - [GH Tyk Pump Repo](https://github.com/TykTechnologies/tyk-pump/releases/tag/v1.12.2)
Suggestion importance[1-10]: 6

__

Why: Adjusting the fenced code block indentation under the list item improves Markdown rendering across engines and simplifying the Docker Hub URL reduces fragility. This enhances readability without altering content.

Low
Provide actual release date

Replace the placeholder with the actual release date to avoid ambiguity. This
ensures consistency with other sections and helps users track timelines accurately.

tyk-docs/content/developer-support/release-notes/pump.md [27]

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

__

Why: Replacing the placeholder #### Release xx with a real date improves clarity and consistency, but it's a content update rather than a functional fix. It's correct and low risk.

Low
Possible issue
Fix internal changelog link

Use a proper self-reference anchor that matches the heading's ID without the leading
hash when using the Hugo ref shortcode. This prevents broken links in the generated
site.

tyk-docs/content/developer-support/release-notes/pump.md [33]

-For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v1.12.2" >}}) below.
+For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "developer-support/release-notes/pump.md#Changelog-v1.12.2" >}}) below.
Suggestion importance[1-10]: 3

__

Why: The existing Hugo ref shortcode with "#Changelog-v1.12.2" may already be valid depending on site configuration; changing to a full path could be unnecessary or break portability. Impact is minor and correctness uncertain.

Low

Copy link

netlify bot commented Sep 26, 2025

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

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

@andyo-tyk andyo-tyk changed the title Pump RNs 1.12.2.md [TT-15797] Pump RNs 1.12.2 Sep 26, 2025
Copy link
Contributor

@andyo-tyk andyo-tyk left a comment

Choose a reason for hiding this comment

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

LGTM


### 1.12.2 Release Notes

#### Release xx
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 date before merging.

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