XML documentation generated in Schema differs between machines
See original GitHub issueDescribe the bug
XML documentation generated in the Schema differs between local machine and on our build agent. Seems to be dependent on the file C:\Users\{user}\.nuget\packages\hotchocolate.aspnetcore.authorization\9.0.1\lib\netstandard2.0\HotChocolate.AspNetCore.Authorization.xml
which is present locally, but not on the build agent. If we delete this file locally and generate the schema, it matches the build agent.
Local:
Build agent:
To Reproduce Steps to reproduce the behavior:
- Generate Schema e.g. via unit test in a project referencing HotChocolate, something similar to:
[Fact]
public void VerifySchema()
{
using (var lifetimeScope = Container.BeginLifetimeScope()) {
var schema = lifetimeScope.Resolve<ISchema>();
var serializedSchema = SchemaSerializer.Serialize(schema);
ApprovalTests.Approvals.Verify(serializedSchema);
}
}
- Run unit test locally with local
C:\Users\{user}\.nuget\packages\hotchocolate.aspnetcore.authorization\9.0.1\lib\netstandard2.0\HotChocolate.AspNetCore.Authorization.xml
file present (should be there by default if your project is referencing HotChocolate via nuget). - Delete
C:\Users\{user}\.nuget\packages\hotchocolate.aspnetcore.authorization\9.0.1\lib\netstandard2.0\HotChocolate.AspNetCore.Authorization.xml
file and run test against. - Observe differences in XML documentation between the 2 test runs.
Expected behavior XML documentation generated in Schema should be the same regardless of what machine the Schema is generated from and what other local nuget files are present.
Desktop: OS: Windows 10
Additional context Referencing HotChocolate.AspNetCore v9.0.1.
Issue Analytics
- State:
- Created 4 years ago
- Comments:5 (1 by maintainers)
Top Results From Across the Web
Specify deployment path for XML documentation output path
There's an easy way to generate an XML documentation file at a relative path. Just set the DocumentationFile property to true :
Read more >Inferring Schemas from XML Documents
Xml.Schema namespace is used to generate one or more XML Schema definition language (XSD) schemas from the structure of an XML document.
Read more >XML Schema Part 1: Structures Second Edition
The purpose of an XML Schema: Structures schema is to define and describe a class of XML documents by using schema components to...
Read more >XML schemas and data in document-level customizations
Objects created when schemas are attached to Excel workbooks ... The following table shows some of the differences between the two methods.
Read more >1. Schema Uses and Development - XML Schema [Book]
XML schemas are frequently used to document XML vocabularies, even when validation isn't a requirement. Schemas provide a formal description of the vocabulary ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
This one should now be fixed with preview.24. Can you two confirm this?
Looks like we have an outstanding issue to include the XML file in our build agent which should fix this. Will resolve for now, thanks for the help Michael