msgraph-sdk-dotnet
msgraph-sdk-dotnet copied to clipboard
microsoftgraph
Please add change log to this repository
Is your feature request related to a problem? Please describe. Currently the repository is missing change log (or I am not able to find it). Whenever a new version of the SDK is released, it is not clear what new features are we getting and what bugs are fixed. As Forrest Gump would say, currently the update process is like a "box of chocolates, you don't know what you're getting" :).
Describe the solution you'd like
A changelog.md file with a description of all the new features and bug fixes in reverse chronological order (i.e. latest release is always on top). Please see this for example.
Describe alternatives you've considered There are no alternatives.
Additional context
I noticed that SDKs for some other languages have a change log (msgraph-sdk-javascript, for example) however they have not been updated in quite some time. It would be really great if same practice can be followed across all SDKs.
Hi @gmantri , Thanks for reaching out and thanks for the feedback. Right now, we do keep release notes for all the Microsoft Graph SDKs and those are built using this Azure DevOps task which by default takes the changelog and adds it as release notes.
As a note, bugfixes are listed, see this release as an example, as long as the information is clearly indicated in the commit message.
The API changelog is the central place to see additions and deprecations to the API. This repo is home to the generated service library that should track the API updates automatically. There should be almost no additional information in these release notes. The core library is where you should expect to find release notes with the details of bugfixes and enhancements to the SDK.
We could standardize on keep a changelog as there's ton of tooling to write the release notes automatically from it, and it keeps a linear changelog anyone can refer to. See the examples on java releases that gets its information from changelog. This is also how the JavaScript SDK does, as you mentioned before.
The benefit of doing that (beside a standard open source approach that's familiar to a lot of people out there) is that the dependabot PRs (or other dependency management tooling) could extract the release notes when updating things. See the difference between a PR that provides a standard changelog and one that doesn't.
@andrueastman this is something we should think about.
This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 4 days. It will be closed if no further activity occurs within 3 days of this comment.
This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 4 days. It will be closed if no further activity occurs within 3 days of this comment.
Hey @andrueastman . I decided to reopen the issue as I really think it's a good idea to have the keep a changelog here as I mentioned in the comment above. Thoughts?
Closed via https://github.com/microsoftgraph/msgraph-sdk-dotnet/pull/1474
