Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Including Generated XML Documentation in an Azure Cloud Service Package

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?

like image 777
RMD Avatar asked Oct 03 '14 17:10

RMD


People also ask

How do I read XML documents?

Just about every browser can open an XML file. In Chrome, just open a new tab and drag the XML file over. Alternatively, right click on the XML file and hover over "Open with" then click "Chrome". When you do, the file will open in a new tab.

What is Cspkg?

cspkg is a zip file that is generated from the ServiceDefinition. csdef and among other things, contains all the required binary-based dependencies. Azure creates a cloud service from both the ServicePackage. cspkg and the ServiceConfig.

Which file specifies the settings that are used by Azure to configure cloud service?

cscfg. The configuration of the settings for your cloud service is determined by the values in the ServiceConfiguration. cscfg file. You specify the number of instances that you want to deploy for each role in this file.


1 Answers

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>

like image 178
sm85 Avatar answered Oct 29 '22 16:10

sm85