You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The release date for version 1.7 is marked as xxxx. This placeholder should be replaced with the actual release date to ensure accuracy and completeness of the documentation.
The compatibility details for third-party dependencies (e.g., MongoDB, Redis) are provided, but it is unclear if these versions have been thoroughly tested or if there are any known issues. This should be validated and clarified.
| Third Party Dependency | Tested Versions | Compatible Versions | Comments || ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- ||[GoLang](https://go.dev/dl/)| 1.21 | 1.21 | All our binaries ||[MongoDB](https://www.mongodb.com/try/download/community)| 5.x, 6.x, 7.0 | 4.4.x, 5.x, 6.x and 7.0.x | Used by Tyk Identity Broker ||[Redis](https://redis.io/download/)| 6.x - 7.0 | 6.x - 7.0 | Used by Tyk Identity Broker |
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.
Ensure the "Changelog" section includes specific features, updates, and fixed issues for version 1.7 to provide users with a clear understanding of the release's impact.
#### Changelog {#Changelog-v1.7.0}
-<!-- Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.+- **Feature A**: Description of the feature and its benefits.+- **Update B**: Explanation of the update and its impact.+- **Fixed Issue C**: Details of the issue fixed and its resolution.-Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):-"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:-"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" -->-
Suggestion importance[1-10]: 4
__
Why: Adding specific features, updates, and fixed issues to the changelog provides clarity and value to users. However, the suggestion is not actionable as it requires detailed information about the release, which is not provided in the PR. The improvement is moderate but depends on external input.
Low
Add the missing release date
Specify the release date for version 1.7 in the "Release Date xxxx" section to ensure clarity and completeness of the release notes.
-#### Release Date xxxx+#### Release Date February 19, 2025
Suggestion importance[1-10]: 3
__
Why: While specifying the release date improves the completeness of the release notes, the suggestion is not actionable as it requires external input (the actual release date). The improvement is minor and does not directly enhance functionality or correctness.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
For internal users - Please add a Jira DX PR ticket to the subject!
Preview Link
Description
Screenshots (if appropriate)
Checklist
master.future-releaseand specify the version (e.g.,future-release, 6.0).4.1,5.1).5.5) andmaster.PR Type
Documentation
Description
Added detailed release notes for TIB version 1.7.
Included dependency compatibility matrix for third-party tools.
Provided upgrade instructions for users on older versions.
Added download links for Docker image and source code tarball.
Changes walkthrough 📝
tib.md
Added TIB 1.7 release notes and related detailstyk-docs/content/developer-support/release-notes/tib.md
Redis.