(#310) Add cmdlet docgeneration script

Added a script to generate and update PlatyPS documentation in the docs repository.
chocolatey · May 13, 2024 · 1b4485c · 1b4485c
1 parent d6cd0f9
commit 1b4485c
Show file tree

Hide file tree

Showing 6 changed files with 1,023 additions and 3 deletions.
diff --git a/recipe.cake b/recipe.cake
@@ -183,8 +183,9 @@ Task("Prepare-Chocolatey-Packages")
 
     StartProcess(BuildParameters.Paths.Directories.ChocolateyNuspecDirectory + "/tools/chocolateyInstall/choco.exe", new ProcessSettings{ Arguments = "unpackself -f -y --allow-unofficial-build --run-actual" });
 
-    // Copy Chocolatey.PowerShell.dll
+    // Copy Chocolatey.PowerShell.dll and its help.xml file
     CopyFile(BuildParameters.Paths.Directories.PublishedLibraries + "/Chocolatey.PowerShell_signed/Chocolatey.PowerShell.dll", BuildParameters.Paths.Directories.ChocolateyNuspecDirectory + "/tools/chocolateyInstall/helpers/Chocolatey.PowerShell.dll");
+    CopyFile(BuildParameters.Paths.Directories.PublishedLibraries + "/Chocolatey.PowerShell/Chocolatey.PowerShell.dll-help.xml", BuildParameters.Paths.Directories.ChocolateyNuspecDirectory + "/tools/chocolateyInstall/helpers/Chocolatey.PowerShell.dll-help.xml");
 
     // Tidy up logs and config folder which are not required
     var logsDirectory = BuildParameters.Paths.Directories.ChocolateyNuspecDirectory + "/tools/chocolateyInstall/logs";
@@ -276,6 +277,7 @@ Task("Prepare-ChocolateyNo7zip-Package")
 
     // Copy Chocolatey.PowerShell.dll and help.xml file
     CopyFile(BuildParameters.Paths.Directories.PublishedLibraries + "/Chocolatey.PowerShell_signed/Chocolatey.PowerShell.dll", nuspecDirectory + "/tools/chocolateyInstall/helpers/Chocolatey.PowerShell.dll");
+    CopyFile(BuildParameters.Paths.Directories.PublishedLibraries + "/Chocolatey.PowerShell/Chocolatey.PowerShell.dll-help.xml", nuspecDirectory + "/tools/chocolateyInstall/helpers/Chocolatey.PowerShell.dll-help.xml");
 
     // Tidy up logs and config folder which are not required
     var logsDirectory = nuspecDirectory + "/tools/chocolateyInstall/logs";

diff --git a/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj b/src/Chocolatey.PowerShell/Chocolatey.PowerShell.csproj
@@ -78,5 +78,10 @@
     <Compile Include="Shared\EnvironmentVariable.cs" />
     <Compile Include="Win32\NativeMethods.cs" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="Chocolatey.PowerShell.dll-Help.xml">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>