Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DX-1644] Gateway 5.6.0 Release notes #5318

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

Conversation

Eopayemi
Copy link
Contributor

@Eopayemi Eopayemi commented Aug 28, 2024

User description

For internal users - Please add a Jira DX PR ticket to the subject!


DX-1644

Preview Link

Preview

Description

5.6.0 release notes for gateway

Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • I labeled the PR

PR Type

Documentation


Description

  • Added comprehensive release notes for Tyk Gateway version 5.6.0, detailing updates, enhancements, and changes.
  • Included a compatibility matrix for Tyk components and third-party dependencies, aiding users in understanding version compatibility.
  • Provided upgrade instructions and a structured changelog to guide users through the new release.
  • Added placeholders for future changelog items and security fixes, ensuring the document is ready for updates.

Changes walkthrough 📝

Relevant files
Documentation
version-5.6.md
Add Tyk Gateway 5.6.0 release notes with detailed sections

tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.6.md

  • Added release notes for Tyk Gateway version 5.6.0.
  • Included compatibility matrix for Tyk components and third-party
    dependencies.
  • Documented upgrade instructions and changelog sections.
  • Added placeholders for changelog items and security fixes.
  • +235/-0 

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Content Placeholder
    The section "Release Highlights" contains a placeholder text "Add release highlights here" which needs to be replaced with actual content before finalizing the release notes.

    Changelog Details
    The changelog sections under "Added", "Changed", and "Fixed" are using placeholders like "Add a new changelog description". These should be detailed with actual changes for clarity and completeness.

    Copy link
    Contributor

    github-actions bot commented Aug 28, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    netlify bot commented Aug 28, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit 082a4eb
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66cf381bc64318000828e438
    😎 Deploy Preview https://deploy-preview-5318--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 site configuration.

    Copy link

    netlify bot commented Aug 28, 2024

    PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit b125eab
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/66f6acd45d9c6200089719ee
    😎 Deploy Preview https://deploy-preview-5318--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 site configuration.

    @dcs3spp dcs3spp marked this pull request as draft August 28, 2024 15:29
    Copy link
    Contributor

    @dcs3spp dcs3spp left a comment

    Choose a reason for hiding this comment

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

    Requires changleog for review and peer reviewers to check compatibility matrix is correct

    <details>
    <summary>Endpoint-Level Rate Limits for Client Control</summary>

    We have introduced support for configuring endpoint-level rate limits in keys and policies. This new feature allows for more granular control over client consumption of API resources, enabling you to manage and optimize API usage more effectively.
    Copy link
    Collaborator

    Choose a reason for hiding this comment

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

    @Eopayemi this needs to be linked to the docs with that content after we release the content

    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