Skip to content

[DX-1942] Dashboard Release Notes 5.8.1 #6289

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 18 commits into from
May 12, 2025
Merged

[DX-1942] Dashboard Release Notes 5.8.1 #6289

merged 18 commits into from
May 12, 2025

Conversation

Eopayemi
Copy link
Contributor

@Eopayemi Eopayemi commented Apr 10, 2025 •
edited by github-actions bot
Loading

User description

Preview Link

Checklist

  • Added a preview link
  • Reviewed AI PR Agent suggestions
  • For Tyk Members - Added Jira DX PR ticket to the subject
  • For Tyk Members - Added the appropriate release labels (for fixes add the latest release)

New Contributors

PR Type

Documentation

Description

  • Added detailed release notes for Dashboard 5.8.1

  • Documented security fix for CVE-2025-46569

  • Listed bug fixes and UI improvements

  • Updated compatibility and dependency matrices

Changes walkthrough 📝

Relevant files
Documentation
dashboard.md
Add 5.8.1 release notes, bug and security fixes                   

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

  • Added a new section for 5.8.1 release notes
  • Documented release highlights, bug fixes, and security fixes
  • Updated compatibility and third-party dependency tables
  • Provided upgrade instructions and download links
    		• +141/-0 
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Apr 10, 2025 •
    edited
    Loading

    PR Reviewer Guide 🔍

    (Review updated until commit b461bb9)

    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 Accuracy

    The release notes reference a security fix for CVE-2025-46569 and several bug fixes. Ensure that the documentation accurately reflects the actual changes and fixes included in the 5.8.1 release, especially for the listed CVE and compatibility matrices.

     
    ### 5.8.1 Release Notes

#### Release Date XXX

#### Release Highlights

This release focuses mainly on a security fix. For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-v5.8.1" >}}) below.

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies {#dependencies-5.8.1}

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|----    |---- |---- |
| 5.8.1 | MDCB v2.8.0     | MDCB v2.8.0 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.0    | Sync v2.1.0 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.13 | EDP all versions |
| | Pump v1.12.0| Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools {#3rdPartyTools-v5.8.0}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins]({{< ref "api-management/plugins/golang" >}}) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Dashboard | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | Used by Tyk Dashboard | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | Used by Tyk Dashboard | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS]({{< ref "api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference" >}})|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions {#upgrade-5.8.1}

If you are upgrading to 5.8.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.1
    ```
- Helm charts
  - [tyk-charts v3.0.0]({{< ref "developer-support/release-notes/helm-chart#300-release-notes" >}})

##### Fixed

<ul>
<li>
<details>
<summary>Improved password error messaging on Add User page</summary>

Improved formatting for the password error on the add user page
</details>
</li>
<li>
<details>
<summary>License allocation now works across multiple dashboards</summary>

Converted license allocation to be stored in a distributed manner to allow a setup with multiple dashboards.
</details>
</li>
<li>
<details>
<summary>Resolved vertical overflow display issue in APIs table</summary>

Fixed display issue on the APIs table rows when content doesn't fit vertically
</details>
</li>
<li>
<details>
<summary>Fixed race condition in gateway license allocation</summary>

Resolved a race condition in gateway license allocation that occasionally allowed more or fewer gateways than licensed to register and serve traffic.
</details>
</li>
<li>
<details>
<summary>Fixed API Category filter on Activity Overview page</summary>

Fixed an issue where the API Category filter did not work as expected on the Activity Overview page in Dashboard Monitoring.
</details>
</li>
<li>
<details>
<summary>Corrected certificate list colors based on private key presence</summary>

Fixed colors on the certificates list table when a certificate contains or does not contain a private key.
</details>
</li>
<li>
<details>
<summary>Fixed API creation from pasted YAML definitions</summary>

Fixed an issue that prevented creation of an API from a YAML format Tyk OAS API definitions using the "paste API definition" method. You can now export your Tyk OAS API definition in YAML or JSON format and use the content of this file to create a new API.
</details>
</li>
<li>
<details>
<summary>Fixed broken cancel button in API promotion flow</summary>

Fixed an issue when using API Designer to migrate an API from Tyk Classic to Tyk OAS. Previously the cancel button did not work when promoting a staged API; this how now been fixed.
</details>
</li>
<li>
<details>
<summary>Replaced crypto.randomUUID() to fix UI errors</summary>

Replaced calls to crypto.randomUUID() which caused errors in the UI.
</details>
</li>
<li>
<details>
<summary>Fixed import issue for Tyk OAS ZIPs with YAML entrypoints</summary>

Resolved a bug that blocked multipart OAS ZIP imports when using a YAML file as the entrypoint.
</details>
</li>
</ul>

#### Security Fixes 

<ul>
<li>
<details>
<summary>High priority CVEs fixed</summary>

Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2025-46569](https://nvd.nist.gov/vuln/detail/CVE-2025-46569)
</details>
</li>
</ul>
    Placeholder Release Date

    The release date is marked as 'XXX'. Confirm that this placeholder is updated to the actual release date before merging.

     
    #### Release Date XXX

    @github-actions GitHub Actions
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Update release date placeholder

    Replace the placeholder XXX with the actual release date to ensure the release notes
    accurately reflect the launch.

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

    -#### Release Date XXX
+#### Release Date 2025-04-10
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion correctly identifies the placeholder and provides a clear, actionable replacement to ensure accuracy in the release notes. The improvement enhances the document's quality and clarity.

    		Medium

    @netlify Netlify
    Copy link

    netlify bot commented Apr 10, 2025

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

    Name Link
    🔨 Latest commit df99a79
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67f76dd0eafe6f0008397f28
    😎 Deploy Preview https://deploy-preview-6289--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.

    @netlify Netlify
    Copy link

    netlify bot commented Apr 10, 2025 •
    edited
    Loading

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

    Name Link
    🔨 Latest commit 3e2a011
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/68219a9846731300084c17bc
    😎 Deploy Preview https://deploy-preview-6289--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.

    @sharadregoti sharadregoti marked this pull request as draft April 15, 2025 12:17
    @sharadregoti sharadregoti marked this pull request as ready for review May 8, 2025 05:30
    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented May 8, 2025

    Persistent review updated to latest commit b461bb9

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented May 8, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    sharadregoti
    sharadregoti reviewed May 9, 2025
    View reviewed changes
    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.

    @Eopayemi Can you update this dashboard file to include the latest version? This will update the latest releases page

    andyo-tyk
    andyo-tyk requested changes May 9, 2025
    View reviewed changes
    @ilijabojanovic ilijabojanovic enabled auto-merge (squash) May 12, 2025 06:47
    @ilijabojanovic ilijabojanovic merged commit 5974b14 into master May 12, 2025
    12 checks passed
    @ilijabojanovic ilijabojanovic deleted the dashboard-5.8.1 branch May 12, 2025 06:57
    @sharadregoti
    Copy link
    Contributor

    /release to release-5.8

    1 similar comment
    @letzya
    Copy link
    Collaborator

    letzya commented May 12, 2025

    /release to release-5.8

    @tykbot tykbot
    Copy link

    tykbot bot commented May 12, 2025

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

    tykbot bot pushed a commit that referenced this pull request May 12, 2025
    @Eopayemi
    [DX-1942] Dashboard Release Notes 5.8.1 (#6289)
    2abc796 
    * 5.8.1

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

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

Co-authored-by: Master <sharadregoti15@gmail.com>

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

Co-authored-by: Master <sharadregoti15@gmail.com>

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

* Apply suggestions from code review

* Fixes

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: Master <sharadregoti15@gmail.com>
Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>

(cherry picked from commit 5974b14)
    @buger buger mentioned this pull request May 12, 2025
    Merged
    @tykbot tykbot
    Copy link

    tykbot bot commented May 12, 2025

    @letzya Created merge PRs

    buger added a commit that referenced this pull request May 12, 2025
    @buger @sharadregoti @andyo-tyk
    Merging to release-5.8: [DX-1942] Dashboard Release Notes 5.8.1 (#6289)
    ccac00d 
    [DX-1942] Dashboard Release Notes 5.8.1 (#6289)

* 5.8.1

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

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

Co-authored-by: Master <sharadregoti15@gmail.com>

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

Co-authored-by: Master <sharadregoti15@gmail.com>

* Update dashboard.md

* Update dashboard.md

* Update dashboard.md

* Apply suggestions from code review

* Fixes

---------

Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
Co-authored-by: Master <sharadregoti15@gmail.com>
Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @sharadregoti sharadregoti sharadregoti approved these changes

    @andyo-tyk andyo-tyk andyo-tyk approved these changes

    Assignees
    No one assigned
    Labels
    5.8.1 Release Notes release-5.8 requires peer review Review effort 2/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    6 participants
    @Eopayemi @sharadregoti @letzya @andyo-tyk @ilijabojanovic @buger