Azure / Azure/azure-sdk-tools

Support Packing Additional Information in CHANGELOGs/Releases Site

Open
#2,867 13 comments 1 reaction 1 assignee Assigned to @sima-zhu View on GitHub
Central-EngSys
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

**Note that the details of how we want to address this issue has changed from what listed in this description. Please read the comments where the path forward is clarified.**

Recently, there have been customer requests on finding the minimum recommended version of a few Java SDKs, be it an ask due to dependency conflicts/issues with newer SDK versions or needing compatibility with external frameworks such as Spring. Some SDKs, such as Cosmos, provide this as additional data in the CHANGELOG ([minimum recommended version](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos/CHANGELOG.md#4180-2021-08-16), [call out to a major dependency change](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos/CHANGELOG.md#4130-2021-03-11)), but this isn't standardized nor easy for a customer to find. It would be good if we could come up with a standard way to present this information to customers be it through metadata fields in our CHANGELOGs that are parsed and pushed out into further documentation such as the [releases site](https://azure.github.io/azure-sdk/releases/latest/index.html) or a section in our READMEs that is standard across repositories. Doing so would offer us a place where we could maintain important messages such as a minimum recommended version due to known security vulnerabilities (ex, if we had used log4j in Java), rolling compatibility for popular frameworks (the Java SDKs only support a few recent releases of Spring but many customers use older versions), or a major performance fix or improvement in an SDK.

cc: @kushagraThapar

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.