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 1.13.0 release notes section

  • Update description to cover 1.X.X series

  • Extend tags and aliases for v1.12, v1.13

  • Include downloads and dependencies table


Diagram Walkthrough

flowchart LR
  meta["Front matter metadata"]
  rn113["1.13.0 release notes section"]
  deps["Dependencies table"]
  downloads["Downloads links/commands"]

  meta -- "expand versions/tags/aliases" --> rn113
  rn113 -- "references" --> deps
  rn113 -- "provides" --> downloads
Loading

File Walkthrough

Relevant files
Documentation
pump.md
Add 1.13.0 notes and update front matter                                 

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

  • Broaden description to 1.X.X series
  • Add tags and aliases for v1.12 and v1.13
  • Introduce new 1.13.0 release notes section
  • Add dependencies, upgrade, downloads, changelog anchor
+47/-2   

@github-actions
Copy link
Contributor

⚠️ Deploy preview for PR #7067 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
Broken Anchors

The internal reference to the changelog uses a Hugo ref with a hash fragment; verify that {{< ref "#Changelog-v1.13.0" >}} correctly resolves to the section with the explicit anchor {#Changelog-v1.13.0} on this page. If not, use a page-relative anchor link instead.

For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v1.13.0" >}}) below.

#### Breaking Changes
Markdown Fencing

The Docker pull command is fenced as bash inside a list; ensure the site renderer supports triple backticks within lists. If not, consider using Hugo highlight shortcodes or indentation-based code blocks to avoid layout issues.

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

@github-actions
Copy link
Contributor

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Replace placeholder release date

Replace the placeholder release date with the exact release date to avoid publishing
incomplete information. Using a placeholder can mislead readers and automated tools
that parse dates.

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

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

__

Why: Replacing the placeholder date improves accuracy and prevents publishing incomplete info, but it's a content verification task rather than a functional code fix.

Low
General
Fix nested code block formatting

Remove the nested code block indentation under the list to ensure proper rendering
in Hugo/Markdown; nested fenced blocks often break formatting. Present the code
block as a top-level fenced block following the list item for consistent display and
copyability.

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

 - [Docker Image v1.13.0](https://hub.docker.com/r/tykio/tyk-pump-docker-pub/tags?page=&page_size=&ordering=&name=v1.13.0)
-  - ```bash
-    docker pull tykio/tyk-pump-docker-pub:v1.13.0
-    ```
 
+```bash
+docker pull tykio/tyk-pump-docker-pub:v1.13.0
+```
+
Suggestion importance[1-10]: 5

__

Why: Flattening the fenced code block improves Markdown/Hugo rendering and copyability; it's a minor formatting enhancement with low risk.

Low
Clean up formatting and casing

Replace the HTML line break with a Markdown-compatible line break or paragraph to
avoid rendering inconsistencies across themes. Also fix the mid-sentence
capitalization of "Instructions".

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

 For users currently on v1.13.0, we strongly recommend promptly upgrading to the latest release.
-<br/>
-Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade Instructions.
 
+Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade instructions.
+
Suggestion importance[1-10]: 5

__

Why: Removing the HTML break and fixing capitalization enhances consistency and readability without impacting functionality.

Low

@netlify
Copy link

netlify bot commented Oct 15, 2025

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

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

1 similar comment
@netlify
Copy link

netlify bot commented Oct 15, 2025

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

Name Link
🔨 Latest commit 72522fe
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68ef97f156e32200082e0b58
😎 Deploy Preview https://deploy-preview-7067--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 791029e
🔍 Latest deploy log https://app.netlify.com/projects/tyk-docs/deploys/68fb4434e9de130008d25e6c
😎 Deploy Preview https://deploy-preview-7067--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
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.

Some suggested changes and one change to be removed as it has been descoped from the release.

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