Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reenable Azure.Messaging.EventGrid.SystemEvents MSDocs publishing #45032

Open
JimSuplizio opened this issue Jul 16, 2024 · 0 comments
Open

Reenable Azure.Messaging.EventGrid.SystemEvents MSDocs publishing #45032

JimSuplizio opened this issue Jul 16, 2024 · 0 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs Event Grid

Comments

@JimSuplizio
Copy link
Member

JimSuplizio commented Jul 16, 2024

This is the explanation from the docs team:
Current ops build is failing on main branch of repo azure-docs-sdk-dotnet, this is caused by the newly introduced package "Azure.Messaging.EventGrid.SystemEvents" in azure-dotnet-preview.
https://github.com/Azure/azure-docs-sdk-dotnet/blob/f577862a0098cf76b5591b4de76247cadd249213/bundlepackages/azure-dotnet-preview.csv#L59

The root cause is:
There is already an MediaJobErrorCategory enum in the package NuGet Gallery | Azure.Messaging.EventGrid 4.24.0
But in NuGet Gallery | Azure.Messaging.EventGrid.SystemEvents 1.0.0-beta.1 it becomes a struct.
Both share the same DocId: T:Azure.Messaging.EventGrid.SystemEvents.MediaJobErrorCategory and mdoc cannot identify them.
The xml file generated becomes mixed and unpredictable and now causes build issue.

Disabling this is trivial, it's the matter of adding skipPublishDocMs: true to the artifact in sdk/eventgrid/ci.yml. Reenabling will simply be removing this line. I'm assigning this issue to myself since the docs team will let me know when this is fixed.

This is the issue in azure-sdk-for-net tracking the library changes.

This is the issue tracking the failure in docs.

@JimSuplizio JimSuplizio self-assigned this Jul 16, 2024
@jsquire jsquire added the Client This issue points to a problem in the data-plane of the library. label Jul 16, 2024
@JimSuplizio JimSuplizio added the Central-EngSys This issue is owned by the Engineering System team. label Jul 16, 2024
@JimSuplizio JimSuplizio removed the Client This issue points to a problem in the data-plane of the library. label Jul 16, 2024
@JimSuplizio JimSuplizio moved this from 🤔 Triage to 📋 Backlog in Azure SDK EngSys 🚢🎉 Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Central-EngSys This issue is owned by the Engineering System team. Docs Event Grid
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants