Including Generated XML Documentation in an Azure Cloud Service Package

10
votes

EDIT: Updated to specify that the issue only occurs when packaging an Azure cloud service CSPKG file.

I have an ASP.NET Web API 2 application that acts as a web role in an Azure cloud service solution. I'd like to use the Web API Help Pages and leverage the XML generated docs to populate them. I'm having trouble figuring out how to get the XML documentation to be included in the Azure cloud packaging of the Web Api project.

The XML documentation correctly makes its way into the bin directory locally and when being published to a file system location, but it's missing when you inspect the cspkg archive or the deployed web roles approot directory.

Is there a way to force the packaging to include the XML?

1
azureasp.net-web-apitfsmsbuildxml-documentation
Why do you need the XML documentation on an Azure instance? – Peter Ritchie
Because I'm leveraging then for the auto-generated web API help pages. – RMD

1 Answers

14
votes

You can set ExcludeXmlAssemblyFiles to false in your Project's PropertyGroup to force all xml files to be included in the Azure package:

<ExcludeXmlAssemblyFiles>false</ExcludeXmlAssemblyFiles>