-
Notifications
You must be signed in to change notification settings - Fork 696
Add xmldocs to generated metadata projects #9868
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds XML documentation to generated metadata classes to suppress CS1591 warnings and updates the test project to use Verify for implicit Xunit imports.
- Inject XML doc comments into the generated
.targets
output for project metadata classes - Remove explicit
using Xunit;
directives now covered by Verify’s implicit usings - Add
Verify.XunitV3
package reference to the test project
Reviewed Changes
Copilot reviewed 70 out of 70 changed files in this pull request and generated no comments.
File | Description |
---|---|
src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.in.targets |
Added <summary> XML comments for generated metadata classes and properties |
tests/Aspire.Hosting.Tests/Aspire.Hosting.Tests.csproj |
Introduced Verify.XunitV3 package reference |
tests/Aspire.Hosting.Tests/**/*.cs |
Removed redundant using Xunit; imports |
I'm looking at fixing this unnecessary using issue |
@davidfowl friendly ping here. Anything I can do to help get this in? Thanks so much! |
46f23ca
to
c2efb7a
Compare
also /cc @mitchdenny as code owner. Thanks so much! |
I'm getting a failure only on Windows that looks like this:
I haven't been able to root cause yet. It seems to either be that MSBuild build servers are hanging around with a different version of .NET 10 (less likely) or the local / arcade install isn't being picked up by the test. However, I'm using the same pattern as the test above (which looks to be disabled for unrelated reasons). I feel bad trying to merge a PR without tests, however I'm not sure how best to proceed, so any help is appreciated. |
I'm not sure what is going on here. @radical - any ideas? Is there a way we can diagnose this? One idea is to try to get a binlog or add more tracing to the test to try to figure out what is the problem. We could also try enabling the other MSBuild test and see if it fails for the same reason. |
A binlog is a good next step. Where / how do I determine the output path for the binlog so it gets packaged up along with the test results? |
|
I have a run with a binlog available here: https://github.com/dotnet/aspire/actions/runs/16152828326/job/45588227053?pr=9868 That makes the failure clear: we're running with a mix of the pre-installed SDK 9, and the local install of SDK 10: However, it's unclear to me how these types of tests should work. I also see https://github.com/dotnet/aspire/blob/d554b8bf24bbb932fe752e41f96c2ff4043b1b23/tests/Shared/TemplatesTesting/BuildEnvironment.cs used elsewhere, but it's unclear if that's the right path for these tests as well. It might also be the case that the CI setup for the local SDK is incomplete, and rather than edit the test we should edit the pipeline? @eerhardt, if you let me know how you'd like these types of tests set up, I'm happy to follow up. |
Do you understand how we are getting 9.0 and 10.0 versions for the different MSBuild properties? This definitely shouldn't be happening. They should be consistent. cc @radical |
|
@radical , looks like even with your change, it's still using |
@eerhardt , thanks for your feedback! I believe I've addressed all your comments. Would you mind taking another look? Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for the contribution.
Will merge once CI passes.
This was originally a part of dotnet#9868, and the fix stands on its own. ----- Try setting the PATH in a os-aware way (cherry picked from commit 08a4b70)
Description
Add xmldocs to the generated metadata files to prevent CS1591 warnings in projects that have documentation generation enabled.
To test the change, I added a reference to Verify. Verify adds an implicit using for Xunit, which then means dropping
using Xunit
throughout the project to avoid IDE0005 errors.Fixes #9197
Checklist
<remarks />
and<code />
elements on your triple slash comments?doc-idea
templatebreaking-change
templatediagnostic
template