Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
111 stars 172 forks source link

Give Option For Sorting Changelog by Version Vs Release data #8515

Open tvaron3 opened 2 months ago

tvaron3 commented 2 months ago

We (CosmosDB Java SDK) were trying to change the azure-cosmos changelog to be ordered by version instead of release date because sometimes customers get confused when we have a hotfix at the top of the changelog thinking that is the most recent version. When we use the release tool, it automatically switches it to be ordered by release date. An option for it to be ordered by version would be helpful. It could be an opt in feature so that it does not affect all of the other changelogs.

kurtzeborn commented 1 month ago

So, we have concerns about doing this because it would mean that anyone who uses this option would generate a changelog file that is inconsistent with the rest of the changelogs we've generated before or any of the changelogs we generate without this option being used. Not sure if we should actually do this.

tvaron3 commented 1 month ago

What is the concern for having different changelogs for different services ?

weshaggard commented 1 month ago

We share a common set of engineering tools and they all use that set tools. If we wanted to change the sorting we would need to do so for all the changelogs.