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

Filter out entry for VerifyTargetingPacksHaveDoc test #3660

Closed
mthalman opened this issue Oct 16, 2023 · 4 comments
Closed

Filter out entry for VerifyTargetingPacksHaveDoc test #3660

mthalman opened this issue Oct 16, 2023 · 4 comments
Assignees
Labels
area-testing Improvements in CI and testing

Comments

@mthalman
Copy link
Member

mthalman commented Oct 16, 2023

The VerifyTargetingPacksHaveDoc test is constantly regressing with each 6.0.1xx servicing release. Each release alternates between requiring Microsoft.AspNetCore.App.Ref/ref/netx.y/System.Runtime.CompilerServices.Unsafe.xml to be listed in the MissingXmlDoc.txt baseline file and not be listed. You can see the history of the changes to this file seeing that this file entry gets swapped in and out each release.

In some cases, there is differences of whether the entry needs to be contained in MissingXmlDoc.txt, depending on which stage is being run (see #3389). This adds further complications.

This adds unnecessary churn to the release. We should either remove the test entirely or add a filter to not include the Microsoft.AspNetCore.App.Ref/ref/netx.y/System.Runtime.CompilerServices.Unsafe.xml in the comparison.

@MichaelSimons
Copy link
Member

@mthalman - I think this test should be disabled immediately to unblock the 6.0 builds until a longer term decision is made.

@MichaelSimons
Copy link
Member

In a way this test is redundant with the SDK content tests. The SDK content tests will provide and indication of xml files missing compared to the Microsoft build. The SDK content tests did not exist at the time this test was originally authored. I tend to think this test should be simply removed.

@MichaelSimons
Copy link
Member

[Triage] There may be a product issue here in why this xml doc file comes and goes. It would be good to validate this in the Microsoft builds. If the Microsoft builds don't have this oscillation issue then it is source build specific. Regardless a separate issue should be logged to address this problem.

Regarding the test itself, we feel that the SDK content tests are where any source-build differences in the xml doc should be caught. It is the product's responsibility to tests that it creates the appropriate xml doc files.

@MichaelSimons
Copy link
Member

The XmlDocTests were already removed in 7.0 - see #3031. This change should have been backported to 6.0 right away.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-testing Improvements in CI and testing
Projects
Archived in project
Development

No branches or pull requests

2 participants