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-1781] Release notes for 5.7.1 #5827

Merged
merged 13 commits into from
Dec 31, 2024
Merged

[DX-1781] Release notes for 5.7.1 #5827

merged 13 commits into from
Dec 31, 2024

Conversation

Eopayemi
Copy link
Contributor

@Eopayemi Eopayemi commented Dec 16, 2024

User description

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

DX-1781


Preview Link


Description

Release notes for 5.7.1

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 Dashboard and Gateway version 5.7.1.
  • Included sections for release highlights, breaking changes, dependencies, deprecations, upgrade instructions, and downloads.
  • Introduced compatibility matrices for Tyk components and third-party dependencies.
  • Added changelog sections for added, changed, and fixed items.

Changes walkthrough 📝

Relevant files
Documentation
dashboard.md
Added detailed release notes for Dashboard version 5.7.1.

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

  • Added release notes for version 5.7.1, including highlights, breaking
    changes, dependencies, deprecations, upgrade instructions, and
    downloads.
  • Introduced compatibility matrix for Tyk components and third-party
    dependencies.
  • Included changelog sections for added, changed, and fixed items.
  • +126/-0 
    gateway.md
    Added detailed release notes for Gateway version 5.7.1.   

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

  • Added release notes for version 5.7.1, including highlights, breaking
    changes, dependencies, deprecations, upgrade instructions, and
    downloads.
  • Introduced compatibility matrix for Tyk components and third-party
    dependencies.
  • Included changelog sections for added, changed, and fixed items.
  • +120/-0 

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    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

    Documentation Clarity
    The changelog sections under "Added", "Changed", and "Fixed" contain placeholder text ("Add changelog description"). Ensure these are updated with specific and meaningful details before merging.

    Documentation Clarity
    The changelog sections under "Added", "Changed", and "Fixed" contain placeholder text ("Add changelog summary"). Ensure these are updated with specific and meaningful details before merging.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Fix grammatical error in the release highlights section for clarity

    Correct the grammatical error in the sentence "This fix focuses mainly on bug fix"
    to ensure clarity and proper grammar.

    tyk-docs/content/developer-support/release-notes/dashboard.md [45]

    -This fix focuses mainly on bug fix.For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.7.1" >}}) below.
    +This fix focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.7.1" >}}) below.
    Suggestion importance[1-10]: 8

    Why: The suggestion correctly identifies and fixes a grammatical error in the release highlights section, improving clarity and professionalism in the documentation.

    8
    Fix grammatical error in the release highlights section by adding proper spacing

    Correct the grammatical error in the sentence "This fix focuses mainly on bug fixes"
    by ensuring proper spacing after the period.

    tyk-docs/content/developer-support/release-notes/gateway.md [53]

    -This fix focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.7.1">}}) below.
    +This fix focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.7.1" >}}) below.
    Suggestion importance[1-10]: 7

    Why: The suggestion addresses a minor formatting issue by ensuring proper spacing after the period, enhancing the readability of the documentation.

    7

    Copy link

    netlify bot commented Dec 16, 2024

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

    Name Link
    🔨 Latest commit 94dfeb0
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67737b731fda160008dbf919
    😎 Deploy Preview https://deploy-preview-5827--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
    Contributor

    @sharadregoti sharadregoti left a comment

    Choose a reason for hiding this comment

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

    TODO: Update release date while merging

    @sharadregoti sharadregoti merged commit 8deca94 into master Dec 31, 2024
    9 checks passed
    @sharadregoti sharadregoti deleted the release-5.7.1 branch December 31, 2024 05:12
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.7

    Copy link

    tykbot bot commented Dec 31, 2024

    Working on it! Note that it can take a few minutes.

    tykbot bot pushed a commit that referenced this pull request Dec 31, 2024
    Copy link

    tykbot bot commented Dec 31, 2024

    @sharadregoti Succesfully merged PR

    buger added a commit that referenced this pull request Dec 31, 2024
    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