Skip to content

Commit

Permalink
Merge branch 'master' into generate-url-availability-file
Browse files Browse the repository at this point in the history
  • Loading branch information
@yurisasuke
yurisasuke authored Jan 23, 2024
2 parents 54bb94b + 52e159f commit dbca4cb
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 89 deletions.
106 changes: 48 additions & 58 deletions tyk-docs/assets/others/release-notes-template.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: "Release notes documenting updates, enhancements and changes for Ty
tags: ["Tyk Dashboard", "Release notes", "changelog", "vX.Y", "X.Y.0", "X.Y", "X.Y.Z"]
---

<!-- oss or licensed. Choose one of the following:
<!-- Required. oss or licensed. Choose one of the following:
**Licensed Protected Product**
Or
****Open Source** ([Mozilla Public License](https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md))**
Expand All @@ -21,7 +21,7 @@ tags: ["Tyk Dashboard", "Release notes", "changelog", "vX.Y", "X.Y.0", "X.Y", "X
**This page contains all release notes for version 5.2.X displayed in a reverse chronological order**

### Support Lifetime
<!-- replace X.Y with this release and set the correct quarter of the year -->
<!-- Required. replace X.Y with this release and set the correct quarter of the year -->
Our minor releases are supported until our next minor comes out. This would be <vX.Y+1> scheduled in Q<1-4> if this goes ahead as planned. If not, X.Y will remain in support until our next LTS version comes out in March 2024.

---
Expand All @@ -31,33 +31,29 @@ Our minor releases are supported until our next minor comes out. This would be <
##### Release Date DD Mon YYYY <<update>>

#### Breaking Changes
<!-- Use the following statement if there are no breaking changes, or explain if there are -->
<!-- Required. Use the following statement if there are no breaking changes, or explain if there are -->
This release has no breaking changes.

<!-- The following "Changed error log messages" section is Optional!
Instructions: We should mention in the changelog section ALL changes in our application log messages. In case we made such changes, this section should also be added, to make sure the users don't miss this notice among other changelog lines. -->
<!-- #### Changed error log messages
Important for users who monitor Tyk components using the application logs (i.e. Tyk Gateway log, Tyk Dashboard log etc.).
We try to avoid making changes to our log messages, especially at error and critical levels. However, sometimes it's necessary. Please find the list of changes made to the application log in this release:
-->
<!-- Optional section!
Instructions: We should mention in the changelog section ALL changes in our application log messages. In case we made such changes, this section should also be added, to make sure the users don't miss this notice among other changelog lines. -->
We try to avoid making changes to our log messages, especially at error and critical levels. However, sometimes it's necessary. Please find the list of changes made to the application log in this release: -->

#### Future Breaking Changes (Optional)
<!-- Announce future scheduled breaking changes, e.g. Go version updates, DB driver updates etc. -->
<!-- The following "|Planned Breaking Changes" section is optional!
Announce future scheduled breaking changes, e.g. Go version updates, DB driver updates etc. -->
<!-- #### Planned Breaking Changes -->

#### Dependencies
<!--
Use this section to announce the following types of dependencies compatible with the release:
<!--Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools
-->
3rd party dependencies and tools -->

##### Compatibility Matrix For Tyk Components
<!--
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below.
-->
<!-- Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. -->
| Gateway Version | Recommended Compatibility | Backwards Compatibility |
|---- |---- |---- |
| 5.3 LTS | Helm v2.2 | Helm vX - vY |
Expand All @@ -69,34 +65,40 @@ An illustrative example is shown below.
| | | TIB vX - vY |

#### 3rd Party Dependencies & Tools
<!-- Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
<!-- Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement should be added for customers to check that the third-party dependency they decide to install remains in support.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA.
-->
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. -->

| Third Party Dependency | Tested Versions | Compatible Versions |
| ---------------------------------------------------------- | ---------------------- | ---------------------- |
| [GoLang](https://go.dev/dl/) | 1.19, 1.20, 1.21 | 1.19, 1.20, 1.21 |
| [MongoDB](https://www.mongodb.com/try/download/community) | 4.4.x, 5.0.x and 6.0.x | 4.4.x, 5.0.x and 6.0.x |
| [PostgreSQL](https://www.postgresql.org/download/) | 11.x - 15.x LTS | 11.x - 15.x |
| Third Party Dependency | Tested Versions | Compatible Versions | Comments |
| ---------------------------------------------------------- | ---------------------- | ---------------------- | -------- |
| [GoLang](https://go.dev/dl/) | 1.19, 1.20, 1.21 | 1.19, 1.20, 1.21 | All our binaries|
| [MongoDB](https://www.mongodb.com/try/download/community) | 4.4.x, 5.0.x and 6.0.x | 4.4.x, 5.0.x and 6.0.x | Used by Tyk Dashboard |
| [PostgreSQL](https://www.postgresql.org/download/) | 11.x - 15.x LTS | 11.x - 15.x | Used by Tyk Dashboard |
| OpenAPI JSON Schema | v3.0.0... | v3.0.0... | Used by [Tyk OAS API definition](https://swagger.io/specification/) | [3.0.3](https://spec.openapis.org/oas/v3.0.3)|

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.

#### Deprecations
<!-- Use the following statement if there are no deprecations, or explain if there are -->
<!-- Required. Use the following statement if there are no deprecations, or explain if there are -->
There are no deprecations in this release.

<!-- Optional section!
Used to share and notify users about our plan to deprecate features, configs etc.
Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. -->
<!-- ##### Future deprecations
-->

#### Upgrade instructions
<!-- For patches release (Z>0) use this:
<!-- Required. For patches release (Z>0) use this:
For users currently on vX.Y.Z, we strongly recommend promptly upgrading to the latest release. If you are working with an older version (lower major), it is advisable to bypass version X.Y.0 and proceed directly to this latest patch release.
<br/>
Go to the [Upgrading Tyk](#upgrading-tyk) section for detailed upgrade Instructions.
-->

#### Release Highlights
<!-- Use similar ToV to previous release notes. For example for a patch release:
<!-- Required. Use similar ToV to previous release notes. For example for a patch release:
This release primarily focuses on bug fixes.
For a comprehensive list of changes, please refer to the detailed [changelog]({{< ref "#Changelog-vX.Y.0">}}) below.
-->
Expand All @@ -112,12 +114,11 @@ Topic in The Release Highlights
- <<source code tarball for oss projects>>

#### Changelog {#Changelog-vX.Y.Z}
<!-- The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
<!-- 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.
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"
-->
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" -->

##### Added
<!-- This section should be a bullet point list of new features. Explain:
Expand All @@ -127,8 +128,7 @@ Here it is important to explain the benefit of each changelog item. As mentioned
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below.
-->
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
<ul>
<li>
<details>
Expand All @@ -148,16 +148,14 @@ The actual changelog item text should go here. It should be no more than three o


##### Changed
<!--
This should be a bullet-point list of updated features. Explain:
<!-- This should be a bullet-point list of updated features. Explain:
- Why was the update necessary?
- How does the update benefit users?
- Link to documentation of the updated feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below.
-->
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
<ul>
<li>
<details>
Expand All @@ -176,16 +174,14 @@ The actual changelog item text should go here. It should be no more than three o
</ul>

##### Fixed
<!--
This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
<!-- This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below.
-->
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. -->
<ul>
<li>
<details>
Expand All @@ -198,14 +194,13 @@ The actual changelog item text should go here. It should be no more than three o
<details>
<summary>Another changelog item summary</summary>

The actual changelog item text should go here. It should be no more than three or four sentences. It should link to content page for further explanation where applicable. There should be a blank line between the summary tags and this paragraph, otherwise links will not be rendered.
The actual changelog item text should go here. It should be no more than three or four sentences. It should link to the content page for further explanation where applicable. There should be a blank line between the summary tags and this paragraph, otherwise, links will not be rendered.
</details>
</li>
</ul>

#### Security Fixes
<!--
This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
<!-- This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.
Expand All @@ -216,8 +211,7 @@ For agreed CVE security fixes, provide a link to the corresponding entry on the
-->

##### Comunity Contributions
<!--
This section should thank external contributors and include a linked reference to their GitHub username with a summary of their contribution.
<!-- This section should thank external contributors and include a linked reference to their GitHub username with a summary of their contribution.
Example
Expand All @@ -234,25 +228,23 @@ Fixed a minor issue with Go Plugin virtual endpoints where a runtime log error w
</ul>
-->

<!-- use 3 hyphens --- between release notes of every patch (minors will be on a separate page) -->
<!-- Required. use 3 hyphens --- between release notes of every patch (minors will be on a separate page) -->
---

<!--
Repeat release notes seection above for every patch here
Repeat the release notes section above for every patch here
-->


<!--
Footer of the release notes page. It contains a further information section with details of how to upgrade Tyk,
links to API documentation and FAQs.
-->
<!-- The footer of the release notes page. It contains a further information section with details of how to upgrade Tyk,
links to API documentation and FAQs. You can copy it from the previous release. -->
## Further Information

### Upgrading Tyk
Please refer to the [upgrading Tyk]({{< ref "upgrading-tyk" >}}) page for further guidance on the upgrade strategy.

### API Documentation
<!-- Update the link to the Gateway "tyk-gateway-api" or dashboard "tyk-dashboard-api" and the Postman collection
<!-- Required. Update the link to the Gateway "tyk-gateway-api" or dashboard "tyk-dashboard-api" and the Postman collection
If there were changes in any of Tyk’s API docs:
Expand All @@ -267,7 +259,5 @@ If there were changes in any of Tyk’s API docs:
Please visit our [Developer Support]({{< ref "frequently-asked-questions/faq" >}}) page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.

### Miscellaneous (Optional)
<!--
For each specific release if there is additional miscellaneous information or announcements that will be helpful to the customer then squads
should add additional sections to their release notes.
-->
<!-- For each specific release if there is additional miscellaneous information or announcements that will be helpful to the customer then squads
should add additional sections to their release notes. -->
Loading

0 comments on commit dbca4cb

Please sign in to comment.