{"id":3314,"date":"2010-02-09T17:13:37","date_gmt":"2010-02-09T17:13:37","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/webdev\/2010\/02\/09\/how-to-extend-target-file-to-include-registry-settings-for-web-project-package\/"},"modified":"2010-02-09T17:13:37","modified_gmt":"2010-02-09T17:13:37","slug":"how-to-extend-target-file-to-include-registry-settings-for-web-project-package","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/how-to-extend-target-file-to-include-registry-settings-for-web-project-package\/","title":{"rendered":"How to extend target file to include registry settings for web project package"},"content":{"rendered":"

Web project package and deployment targets files are written with extensibility in mind.  User can easily extend a property to include more functionalities in their package by using msbuild targets and properties.  <\/p>\n

If we check the Microsoft.Web.Publishing.targets file under \u201c%Program Files%MSBuildMicrosoftVisualStudiov10.0Web\u201d, we can see the following, which means if file $(WebPublishPipelineProjectName).wpp.targets exists in the project directory, we\u2019ll import it automatically when build package or publish.<\/p>\n

  <!--<\/span>***************************************************************<\/span>-->\n  <!--<\/span>To allow the Team build to have custom setting for the Web Application project without change the project file  <\/span>-->\n  <!--<\/span>by default, if user have a file call $(WebPublishPipelineProjectName).wpp.targets, we will import these setting in before we start  <\/span>-->\n  <!--<\/span>***************************************************************<\/span>-->\n  <<\/span>PropertyGroup<\/span>>\n    <<\/span>WebPublishPipelineCustomizeTargetFile <\/span>Condition<\/span>=<\/span>"'$(WebPublishPipelineCustomizeTargetFile)'==''<\/span>"><\/span>$(WebPublishPipelineProjectDirectory)$(WebPublishPipelineProjectName).wpp.targets<\/<\/span>WebPublishPipelineCustomizeTargetFile<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>Import <\/span>Project<\/span>=<\/span>"$(WebPublishPipelineCustomizeTargetFile)<\/span>" Condition<\/span>=<\/span>"Exists($(WebPublishPipelineCustomizeTargetFile))<\/span>"\/>\n\n<\/span><\/pre>\n
<\/a><\/p>\n
Here\u2019s steps to create a customized target file to include some registry keys in the web package by using msdeploy\u2019s regKey provider<\/a>. (The link contains the functionality and limitation of regKey provider)<\/p>\n
 <\/p>\n
1. Create a file WebApplicationName.wpp.targets in the same folder as your web project (e.g. if the project file is WebApplication1.vbproj, then name the file WebApplication1.wpp.targets) with following content:<\/p>\n
<!--<\/span>********************************************************************<\/span>-->\n<!-- <\/span>Task CollectRegKeysForPackage <\/span>-->\n<!-- <\/span>RegKey reference: http:\/\/technet.microsoft.com\/en-us\/library\/dd569085(WS.10).aspx <\/span>-->\n<!--<\/span>********************************************************************<\/span>-->\n<<\/span>Project <\/span>xmlns<\/span>=<\/span>"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003<\/span>">\n  <<\/span>PropertyGroup<\/span>>\n    <!--<\/span>Targets get execute before this Target<\/span>-->\n    <<\/span>OnBeforeCollectRegKeysForPackage <\/span>Condition<\/span>=<\/span>"'$(OnBeforeCollectRegKeysForPackage)'==''<\/span>">\n    <\/<\/span>OnBeforeCollectRegKeysForPackage<\/span>>\n    <!--<\/span>Targets get execute after this Target<\/span>-->\n    <<\/span>OnAfterCollectRegKeysForPackage <\/span>Condition<\/span>=<\/span>"'$(OnAfterCollectRegKeysForPackage)'==''<\/span>">\n    <\/<\/span>OnAfterCollectRegKeysForPackage<\/span>>\n\n    <<\/span>CollectRegKeysForPackageDependsOn <\/span>Condition<\/span>=<\/span>"'$(CollectRegKeysForPackageDependsOn)'==''<\/span>">\n      <\/span>$(OnBeforeCollectRegKeysForPackage);\n      Build;\n    <\/<\/span>CollectRegKeysForPackageDependsOn<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>PropertyGroup<\/span>>\n    <<\/span>IncludeRegKeyForMyProject <\/span>Condition<\/span>=<\/span>"'$(IncludeRegKeyForMyProject)'==''<\/span>"><\/span>False<\/<\/span>IncludeRegKeyForMyProject<\/span>>\n    <<\/span>MyRegKeyPath <\/span>Condition<\/span>=<\/span>"'$(MyRegKeyPath)'==''<\/span>"><\/<\/span>MyRegKeyPath<\/span>>\n    <<\/span>AfterAddContentPathToSourceManifest <\/span>Condition<\/span>=<\/span>"'$(AfterAddContentPathToSourceManifest)'==''<\/span>">\n      <\/span>$(AfterAddContentPathToSourceManifest);\n      CollectRegKeysForPackage;\n    <\/<\/span>AfterAddContentPathToSourceManifest<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>ItemGroup<\/span>>\n    <<\/span>MyRegkeys <\/span>Include <\/span>= <\/span>"$(MyRegKeyPath)<\/span>"\/>\n  <\/<\/span>ItemGroup<\/span>>\n\n  <<\/span>Target <\/span>Name<\/span>=<\/span>"CollectRegKeysForPackage<\/span>"\n          DependsOnTargets<\/span>=<\/span>"$(CollectRegKeysForPackageDependsOn)<\/span>"\n          Condition<\/span>=<\/span>"$(IncludeRegKeyForMyProject) AND '$(MyRegKeyPath)'!=''<\/span>">\n<\/span>\n    <<\/span>Message <\/span>Text<\/span>=<\/span>"Adding %(MyRegkeys.Identity)<\/span>" \/>\n    <<\/span>ItemGroup<\/span>>\n      <<\/span>MsDeploySourceManifest <\/span>Include<\/span>=<\/span>"regkey<\/span>"\n                                 Condition<\/span>=<\/span>"$(IncludeRegKeyForMyProject)<\/span>">\n        <<\/span>Path<\/span>><\/span>%(MyRegkeys.Identity)<\/<\/span>Path<\/span>>\n      <\/<\/span>MsDeploySourceManifest<\/span>>\n    <\/<\/span>ItemGroup<\/span>>\n    <<\/span>CallTarget <\/span>Targets<\/span>=<\/span>"$(OnAfterCollectRegKeysForPackage)<\/span>" RunEachTargetSeparately<\/span>=<\/span>"false<\/span>" \/>\n  <\/<\/span>Target<\/span>>\n<\/<\/span>Project<\/span>>\n\n<\/span><\/pre>\n
<\/a><\/p>\n
2. Package the project from command line using parameters such as the following to include multiple registry keys (seperated by ; sign) in the package.<\/p>\n
msbuild WebApplication1.vbproj \/target:package \/p:IncludeRegKeyForMyProject=True;MyRegKeyPath="hkey_current_usercontrol paneldesktopwindowmetrics;hkey_current_usercontrol paneldesktopcolors"<\/p>\n
In objdebugpackageWebApplication1.SourceManifest.xml file, you should see two regkey providers are defined:<\/p>\n
<?<\/span>xml <\/span>version<\/span>=<\/span>"1.0<\/span>" encoding<\/span>=<\/span>"utf-8<\/span>"?>\n<<\/span>sitemanifest<\/span>>\n  <<\/span>regkey <\/span>path<\/span>=<\/span>"hkey_current_usercontrol paneldesktopwindowmetrics<\/span>" \/>\n  <<\/span>regkey <\/span>path<\/span>=<\/span>"hkey_current_usercontrol paneldesktopcolors<\/span>" \/>\n  <<\/span>IisApp <\/span>path<\/span>=<\/span>"D:tempWebApplication1WebApplication1objDebugPackagePackageTmp<\/span>" managedRuntimeVersion<\/span>=<\/span>"v4.0<\/span>" \/>\n  <<\/span>setAcl <\/span>path<\/span>=<\/span>"D:tempWebApplication1WebApplication1objDebugPackagePackageTmp<\/span>" setAclResourceType<\/span>=<\/span>"Directory<\/span>" \/>\n  <<\/span>setAcl <\/span>path<\/span>=<\/span>"D:tempWebApplication1WebApplication1objDebugPackagePackageTmp<\/span>" setAclUser<\/span>=<\/span>"anonymousAuthenticationUser<\/span>" setAclResourceType<\/span>=<\/span>"Directory<\/span>" \/>\n<\/<\/span>sitemanifest<\/span>>\n<\/span><\/pre>\n
<\/a><\/p>\n
3. To proves it works, we change the hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth from \u2013285 to \u2013284, then we deploy the package locally from command line:<\/p>\n
\n
WebApplication1.deploy.cmd \/y<\/p>\n<\/blockquote>\n
4. We see the following line which showed that the corresponding registry is updated.<\/p>\n
Info: Updating regValue (hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth).<\/p>\n
5. Or we can import the package from IIS<\/p>\n
\"image\"<\/a> <\/p>\n
After installation finishes, from its details tab, there are the following messages:<\/p>\n
[2\/9\/2010 11:55:05 AM] Source regValue (hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth) does not match destination (hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth) differing in attributes (value[‘-285′,’-284′]). Update pending. \n  
[2\/9\/2010 11:55:05 AM] Source regValue (hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth) replaced with changed attributes (parameters) because of rule EnvironmentVariableNormalize. <\/p>\n
[2\/9\/2010 11:55:05 AM] Updating regValue (hkey_current_usercontrol paneldesktopwindowmetricsMenuWidth).<\/p>\n
 <\/p>\n
If you simply want to hardcode the registry keys for your project and don\u2019t want to worry about more extensions, here\u2019s a simplified version:<\/p>\n
<!--<\/span>********************************************************************<\/span>-->\n<!-- <\/span>Task CollectRegKeysForPackage <\/span>-->\n<!-- <\/span>RegKey reference: http:\/\/technet.microsoft.com\/en-us\/library\/dd569085(WS.10).aspx <\/span>-->\n<!--<\/span>********************************************************************<\/span>-->\n<<\/span>Project <\/span>xmlns<\/span>=<\/span>"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003<\/span>">\n\n  <<\/span>PropertyGroup<\/span>>\n    <!-- <\/span>Extends the AfterAddContentPathToSourceManifest action do also collect registry keys<\/span>-->\n    <!-- <\/span>Hard code <\/span>-->\n    <<\/span>MyRegKeyPath <\/span>Condition<\/span>=<\/span>"'$(MyRegKeyPath)'==''<\/span>"><\/span>hkey_current_usercontrol paneldesktopwindowmetrics;hkey_current_usercontrol paneldesktopcolors<\/<\/span>MyRegKeyPath<\/span>>\n    <<\/span>AfterAddContentPathToSourceManifest <\/span>Condition<\/span>=<\/span>"'$(AfterAddContentPathToSourceManifest)'==''<\/span>">\n      <\/span>$(AfterAddContentPathToSourceManifest);\n      CollectRegKeysForPackage;\n    <\/<\/span>AfterAddContentPathToSourceManifest<\/span>>\n  <\/<\/span>PropertyGroup<\/span>>\n\n  <<\/span>ItemGroup<\/span>>\n    <<\/span>MyRegkeys <\/span>Include <\/span>= <\/span>"$(MyRegKeyPath)<\/span>"\/>\n  <\/<\/span>ItemGroup<\/span>>\n  \n<\/span><\/pre>\n
  <<\/span>Target <\/span>Name<\/span>=<\/span>"CollectRegKeysForPackage<\/span>" Condition<\/span>=<\/span>"'$(MyRegKeyPath)'!=''<\/span>">\n    <<\/span>Message <\/span>Text<\/span>=<\/span>"Adding %(MyRegkeys.Identity)<\/span>" \/>\n    <<\/span>ItemGroup<\/span>>\n      <<\/span>MsDeploySourceManifest <\/span>Include<\/span>=<\/span>"regkey<\/span>">\n        <<\/span>Path<\/span>><\/span>%(MyRegkeys.Identity)<\/<\/span>Path<\/span>>\n      <\/<\/span>MsDeploySourceManifest<\/span>>\n    <\/<\/span>ItemGroup<\/span>>\n  <\/<\/span>Target<\/span>>\n<\/span><\/pre>\n
<\/a><\/p>\n
<\/span><\/<\/span>Project<\/span>>\n<\/span><\/pre>\n
Note: if you change an existing target file (this.wpp.targets).  You need to restart VS IDE to allow the target file cache to be unloaded and reloaded, in order for package\/publish using the change.<\/p>\n
Xinyang Qiu | Visual Web Devloper<\/span><\/pre>\n
<\/a><\/p>\n
<\/span><\/pre>\n","protected":false},"excerpt":{"rendered":"
Web project package and deployment targets files are written with extensibility in mind.  User can easily extend a property to include more functionalities in their package by using msbuild targets and properties.  If we check the Microsoft.Web.Publishing.targets file under \u201c%Program Files%MSBuildMicrosoftVisualStudiov10.0Web\u201d, we can see the following, which means if file $(WebPublishPipelineProjectName).wpp.targets exists in the project […]<\/p>\n","protected":false},"author":404,"featured_media":58792,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[197],"tags":[7352,7343,7353,7354,7323,7329],"class_list":["post-3314","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-aspnet","tag-package","tag-publish","tag-target-extension","tag-target-file","tag-visual-studio-2010","tag-web-deployment"],"acf":[],"blog_post_summary":"
Web project package and deployment targets files are written with extensibility in mind.  User can easily extend a property to include more functionalities in their package by using msbuild targets and properties.  If we check the Microsoft.Web.Publishing.targets file under \u201c%Program Files%MSBuildMicrosoftVisualStudiov10.0Web\u201d, we can see the following, which means if file $(WebPublishPipelineProjectName).wpp.targets exists in the project […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/3314","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/404"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=3314"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/3314\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=3314"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=3314"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=3314"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}