microsoftgraph / microsoftgraph/msgraph-beta-sdk-dotnet
Need a way to associate releases to metadata versions
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 112
- Forks
- 37
- Avg merge
- 14h 57m
- Merged PRs (30d)
- 3
Description
Today, we take a snapshot from https://graph.microsoft.com/beta/$metadata, write it to https://github.com/microsoftgraph/msgraph-metadata/blob/master/beta_metadata.xml and then continue with XSLT and SDK generation. After the generation, there is no easy way to associate SDK release to which version of metadata it has consumed.
One can go to release date, check when the PR is opened, then associate the date/time of that to the beta_metadata.xml version, but this is a long path. And it can cause confusion when the releases are skipped or PRs take long time etc.
I would propose one or more of the following:
- Having a link to
beta_metadata.xmlfile in release notes with a commit hash. Linking to main branch won't work as the branch moves forward. - Checking in the version of beta_metadata.xml into
msgraph-beta-sdk-dotnetrepo. Release notes already link to a snapshot of the repository at the time of release. - Having a folder for releases in
msgraph-metadatato keep the snapshots of metadata.
The argument for option 3 vs option 2 is that metadata files will live metadata repo, where SDK goes to SDK repo. But doing this in metadata repo can't be language-agnostic, given that SDK generations for different languages are independently versioned.
Same issue should be addressed for v1.0 as well.
AB#7134
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the release process around beta_metadata.xml in the msgraph-metadata repository and the release notes in msgraph-beta-sdk-dotnet. Compare the proposed commit-hash link, checked-in metadata version, and metadata release-folder approaches, including how the same decision would apply to v1.0; done means selecting and documenting an unambiguous association between each SDK release and its metadata snapshot.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100