msgraph-sdk-dotnet icon indicating copy to clipboard operation
msgraph-sdk-dotnet copied to clipboard

Request for more meaningful release notes

Open WolfgangHG opened this issue 1 year ago • 4 comments

Most time, the code changes in this project are auto generated by some external process. I have the impression that the release notes of this process changed during the last months. Earlier, it was sometimes possible to find out what was changed in a certain release. But nowadays, the commit "update request builders and models" does not contain any detail information on the changes and no link to resolved issues.

Is it possible to create release notes that contain information on the underlying changes?

Or could you at least provide a link to the changelog for the part that caused the "update request builders and models" commit?

WolfgangHG avatar Oct 27 '24 11:10 WolfgangHG

I've created similar issue in another repository, but there is no response from the maintainers for several months.

https://github.com/microsoftgraph/msgraph-metadata/issues/650

I believe that SDK deserver a better changelog.

MartinM85 avatar Oct 29 '24 06:10 MartinM85

Hi @WolfgangHG / @MartinM85 thank you both for your patience as we are working through this backlog.

For context, as @WolfgangHG noted we are currently using an automated tool to make sure the SDK is upto date with the latest change in the APIs. The release notes are also extracted from the commit messages.

In order to make an improvement to our CHANGELOG, we will need to a tool that can summarize the changes between current SDK generated commits, it will need to summarize the changes in the API surface, unfortunately this is something that we can not prioritize as of now

if either of you is willing I can help point you to kiota which is used to generate this SDK, you can then work out a tool that will read the dom-export file and generate a summary

rkodev avatar Apr 15 '25 14:04 rkodev

@rkodev I wanted to take a look at the content of the link "dom-export file", but it did not work for me. Looking at the page source, I think it should be https://raw.githubusercontent.com/microsoftgraph/msgraph-sdk-dotnet/refs/heads/main/src/Microsoft.Graph/Generated/kiota-dom-export.txt ? What is the meaning of this file? Is it a list of classes/methods/properties of the generated API? And a tool would have to create some kind of diff to the previous version? The result would be a list of added/changed API parts?

Still far away from the point that I could offer help - just trying to understand... ;-)

WolfgangHG avatar Apr 15 '25 18:04 WolfgangHG

Hi @rkodev, just out of curiosity...who is the maintainer of this repo now? Lots of new questions without any response for over 2 months.

MartinM85 avatar May 12 '25 04:05 MartinM85