microsoftgraph / microsoftgraph/msgraph-metadata

Changelog for metadata and better validation

Open
#650 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ToTriage
Dominant language
XSLT
Stars
166
Forks
55
Avg merge
16h 12m
Merged PRs (30d)
14

Description

Is there any chance to generate a changelog when metadata are changed?

As a developer I've no idea what exactly was added or removed.

The only way is to check pull requests for SDKs, but pull requests have changes in thousands of files

https://github.com/microsoftgraph/msgraph-sdk-dotnet/pull/2521/files
https://github.com/microsoftgraph/msgraph-sdk-dotnet/pull/2530/files

The changelog can help me decide whether to update to a new version or not.

The most frequent changes are in the comments, so changes in the comments do not have to be mentioned in the changelog.

The comments are the things where the most mistakes are visible at first glance. Obviously, no one is checking the changes.

Updating the .NET SDK takes seconds, but in case of PowerShell SDK, it takes (tens of) minutes

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked SDK pull requests (#2521 and #2530) and compare their metadata changes with the generated files. Define how additions, removals, and validation findings should appear while excluding comment-only changes; done means a changelog makes SDK-impacting metadata changes understandable without inspecting thousands of files.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.