Repository navigation
feat: add Purview.OpenAPI.XmlComments - #1
Merged
Merged
Conversation
An MSBuild development-dependency package that removes colliding documentation IDs from the referenced XML documentation the Microsoft.AspNetCore.OpenApi XML-comment generator reads (dotnet/aspnetcore#67192), warns with POAX001 about project/reference overlaps, and ships the purview-openapi-xmlcomments-duplicates agent skill with its diagnostic script.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
Purview.OpenAPI.XmlComments, an MSBuild development-dependency package that works around theMicrosoft.AspNetCore.OpenApiXML-comment generator's duplicate-key crash (dotnet/aspnetcore#67192) without removing the generator.AdditionalFiles(after the generator's~ReturnTypenormalisation), plus anyPurviewOpenAPIXmlCommentExcludeIDs, and swaps filtered copies in.POAX001warns about an ID documented in both the project and one reference, naming the exclude to add.purview-openapi-xmlcomments-duplicatesagent skill, withfind-duplicate-documentation-ids.ps1(-Json, exit codes 0/1/2).docs/wiki(including Troubleshooting and Agent Skills).Validated locally:
dotnet purview-buildwith pack validation (2/2 packages valid), 78 test runs (unit on net10.0/net11.0, integration, skill conformance), and the packed-consumer gate.Merging to
mainrunsrelease.yml, which publishes1.0.0-prerelease.1to nuget.org through Trusted Publishing, so that needs setting up for this repository first.