🚀 Publish External Help with module (#319)

* 🚀 Update CI

Publish built module properly

* 🚀 Update deployment targets

* 🚀 fail CI on publish if XML is missing

Author: vexx32

Build/Psake.ps1

@@ -90,7 +90,7 @@ $Lines
     # Bump the module version if we didn't already
     try {
         $GalleryVersion = Get-NextNugetPackageVersion -Name $env:BHProjectName -ErrorAction Stop
-        $GithubVersion = Get-MetaData -Path $env:BHPSModuleManifest -PropertyName ModuleVersion -ErrorAction Stop
+        $GithubVersion = Get-Metadata -Path $env:BHPSModuleManifest -PropertyName ModuleVersion -ErrorAction Stop
         if ($GalleryVersion -ge $GithubVersion) {
             Update-Metadata -Path $env:BHPSModuleManifest -PropertyName ModuleVersion -Value $GalleryVersion -ErrorAction stop
         }
@@ -104,4 +104,9 @@ Continuing with existing version.
 
     # Build external help files from Platyps MD files
     New-ExternalHelp -Path "$ProjectRoot/docs/" -OutputPath "$ProjectRoot/PSKoans/en-us"
+
+    $BuiltModuleFolder = "$ProjectRoot/BuiltModule/"
+    Write-Host "##vso[task.setvariable variable=BuiltModuleFolder]$BuiltModuleFolder"
+    New-Item -Path $BuiltModuleFolder -ItemType Directory
+    Copy-Item -Path "$ProjectRoot/PSKoans" -Destination $BuiltModuleFolder -Recurse -PassThru
 }

Deploy/FileSystem/PSKoans.psdeploy.ps1

@@ -1,9 +1,9 @@
 Deploy Module {
     By PSGalleryModule {
-        FromSource PSKoans
+        FromSource "$PSScriptRoot/PSKoans"
         To FileSystem
         WithOptions @{
-            ApiKey = $ENV:NugetApiKey
+            ApiKey = 'FileSystem'
         }
     }
 }

Deploy/PSGallery/PSKoans.psdeploy.ps1

@@ -1,6 +1,6 @@
 Deploy Module {
     By PSGalleryModule {
-        FromSource PSKoans
+        FromSource "$PSScriptRoot/PSKoans"
         To PSGallery
         WithOptions @{
             ApiKey = $ENV:NugetApiKey

Deploy/Publish.ps1

@@ -10,7 +10,7 @@ param(
     $OutputDirectory
 )
 
-$ENV:NugetApiKey = $Key
+$env:NugetApiKey = $Key
 
 if ($OutputDirectory) {
     $Params = @{
@@ -33,6 +33,21 @@ if ($OutputDirectory) {
     }
 }
 
+$HelpFile = Get-ChildItem -Path $Path -File -Recurse -Filter '*-help.xml'
+
+if ($HelpFile.Directory -notmatch 'en-us|\w{1,2}-\w{1,2}') {
+    $PSCmdlet.WriteError(
+        [System.Management.Automation.ErrorRecord]::new(
+            [IO.FileNotFoundException]::new("Help files are missing!"),
+            'Build.HelpXmlMissing',
+            'ObjectNotFound',
+            $null
+        )
+    )
+
+    exit 404
+}
+
 $DeploymentParams = @{
     Path    = $Path
     Recurse = $false

azure-pipelines.yml

@@ -26,7 +26,7 @@ jobs:
   - task: PublishPipelineArtifact@1
     displayName: 'Publish Built Module Artifact'
     inputs:
-      path: '$(System.DefaultWorkingDirectory)/PSKoans'
+      path: '$(BuiltModuleFolder)/PSKoans'
       artifact: PSKoans
 
 - job: Windows