Change a few assumptions

Author: Jaykul

.markdownlint.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD007": {
+    "indent": 4
+  },
+  "MD013": {
+    "line_length": 120,
+    "code_block_line_length": 120
+  }
+}

DotNetPublish.Task.ps1

@@ -8,13 +8,12 @@ Add-BuildTask DotNetPublish @{
     }
     Outputs = {
         Split-Path $dotnetProjects -Leaf |
-            Join-Path -Path { "$PublishRoot${/}$_" } -ChildPath { "$_.dll" }
+            Join-Path -Path { "$DotNetPublishRoot${/}$_" } -ChildPath { "$_.dll" }
     }
     Jobs    = "DotNetBuild", {
         $local:options = @{} + $script:dotnetOptions
 
-        # The PublishRoot is the pub folder within the OutputRoot (used for dotnet publish output)
-        $script:PublishRoot = New-Item (Join-Path $script:OutputRoot publish) -ItemType Root -Force -ErrorAction SilentlyContinue | Convert-Path
+        $script:DotNetPublishRoot = New-Item $script:DotNetPublishRoot -ItemType Root -Force -ErrorAction SilentlyContinue | Convert-Path
 
         # We never do self-contained builds
         if ($options.ContainsKey("-runtime") -or $options.ContainsKey("-ucr")) {
@@ -28,8 +27,8 @@ Add-BuildTask DotNetPublish @{
             }
 
             Set-Location $project
-            Write-Build Gray "dotnet publish --output $PublishRoot${/}$Name --no-build --configuration $configuration -p $($options["p"])"
-            dotnet publish --output "$PublishRoot${/}$Name" --no-build --configuration $configuration
+            Write-Build Gray "dotnet publish --output $DotNetPublishRoot${/}$Name --no-build --configuration $configuration -p $($options["p"])"
+            dotnet publish --output "$DotNetPublishRoot${/}$Name" --no-build --configuration $configuration
         }
     }
 }

PSModuleAnalyze.Task.ps1

@@ -1,7 +1,7 @@
 Add-BuildTask PSModuleAnalyze PSModuleBuild, {
     $ScriptAnalyzer = @{
         IncludeDefaultRules = $true
-        Path                = $PSModuleManifestPath -replace "d1$","*1"
+        Path                = Get-ChildItem $PSModuleOutputPath -Filter $PSModuleName.ps*1 -Recurse
         Settings            = if (Test-Path "$BuildRoot\ScriptAnalyzerSettings.psd1") {
             "$BuildRoot\ScriptAnalyzerSettings.psd1"
         } else {

PSModuleImport.Task.ps1

@@ -1,8 +1,6 @@
 Add-BuildTask PSModuleImport "PSModuleRestore", "PSModuleBuild", {
     # Always re-import the module -- don't try to guess if it's been changed
-    if (-not(Test-Path $PSModuleManifestPath)) {
-        throw "Could not find ManifestPath '$PSModuleManifestPath'"
-    } else {
+    if ($PSModuleManifestPath = Get-ChildItem $PSModuleOutputPath -Filter "$PSModuleName.psm1" -Recurse -ErrorAction Ignore) {
 
         if (($loaded = Get-Module -Name $PSModuleName -All -ErrorAction Ignore)) {
             "Unloading Module '$PSModuleName' $($loaded.Version -join ', ')"
@@ -11,5 +9,7 @@ Add-BuildTask PSModuleImport "PSModuleRestore", "PSModuleBuild", {
 
         "Importing Module '$PSModuleName' $($Script:GitVersion.SemVer) from '$PSModuleManifestPath'"
         Import-Module -Name $PSModuleManifestPath -Force -PassThru:$PassThru
+    } else {
+        throw "Cannot find module manifest $PSModuleName in '$PSModuleOutputPath'"
     }
 }

PSModuleTest.Task.ps1

@@ -44,6 +44,7 @@ Add-BuildTask PSModuleTest @{
             $TestModulePath = @($OutputRoot) + @($Env:PSMODULEPATH -split [IO.Path]::PathSeparator -ne $OutputRoot) -join [IO.Path]::PathSeparator
             $Env:PSMODULEPATH, $OldModulePath = $TestModulePath, $Env:PSMODULEPATH
             try {
+                $PSModuleManifestPath = Get-ChildItem $PSModuleOutputPath -Filter "$PSModuleName.psm1" -Recurse -ErrorAction Ignore
                 Write-Output (@(
                         "Set PSModulePath:"
                         $Env:PSMODULEPATH
@@ -57,7 +58,7 @@ Add-BuildTask PSModuleTest @{
 
 
                 if ($Script:RequiredCodeCoverage -gt 0.00) {
-                    $CodeCoveragePath = [IO.Path]::ChangeExtension($PSModuleManifestPath, ".psm1")
+                    $CodeCoveragePath = $PSModuleManifestPath
                     $CodeCoverageOutputPath = "$OutputRoot\coverage.xml"
                     $CodeCoveragePercentTarget = $RequiredCodeCoverage
                 }

README.md

@@ -5,3 +5,41 @@
 
 I've started using Invoke-Build to run my builds in PowerShell (due mostly to unhappiness with GitHub and Azure Pipelines).
 This is a collection of tasks I've written that get shared by all my project builds.
+
+## Usage
+
+Your .build.ps1 script _must_ set variables:
+
+### For PowerShell modules
+
+- `$PSModuleName`
+    - The name of the module you're building.
+    - There **must** be a .psd1 module manifest with this name in your source.
+    - The build will create a folder with this name in the output folder
+
+If you're including building a dotnet project, it's also recommended to set
+
+- `$DotNetPublishRoot`
+    - The target folder for dotnet publish.
+    - Defaults to `$OutputRoot/publish`
+    - For PowerShell modules, I always override this to `$BuildRoot/lib` and add that to the `CopyDirectories` list
+      in my ModuleBuilder `build.psd1` so that it gets copied to the output folder by ModuleBuilder.
+
+### For DotNet assemblies
+
+- `$dotnetProjects`
+    - Specifies which projects to build
+    - I recommend you put this as a parameter on your Build.ps1
+        - Set the default to the full list of your assembly projects
+        - Add an alias: "Projects"
+- `$dotnetTestProjects`
+    - Specifies which projects are test projects
+    - I recommend you put this as a parameter on your Build.ps1
+    - Add an alias: "TestProjects"
+- `$dotnetOptions`
+    - Specifies further options to pass to dotnet
+    - I recommend you put this as a parameter on your Build.ps1
+    - Add an alias: "Options"
+    - Example values:
+        "-verbosity" = "minimal"
+        "-runtime" = "linux-x64"

_Initialize.ps1

@@ -6,16 +6,10 @@
 #>
 [CmdletBinding()]
 param(
-    # Initialize the dotnet variables and import the dotnet tasks
-    [switch]$DotNet,
-
-    # Initialize the PowerShell module variables and import the tasks
-    [switch]$PowerShell,
-
     # Skip importing tasks
     [switch]$NoTasks
-
 )
+
 $InformationPreference = "Continue"
 $ErrorView = 'DetailedView'
 $ErrorActionPreference = 'Stop'
@@ -116,8 +110,10 @@ Write-Information "  BranchName: $script:BranchName"
 #endregion
 
 #region DotNet task variables. Find the DotNet projects once.
-if ($DotNet) {
+if ($dotnetProjects) {
     Write-Information "Initializing DotNet build variables"
+    # The DotNetPublishRoot is the "publish" folder within the OutputRoot (used for dotnet publish output)
+    $script:DotNetPublishRoot ??= Join-Path $script:OutputRoot publish
 
     # The projects are expected to each be in their own folder
     # Dotnet allows us to pass it the _folder_ that we want to build/test
@@ -155,12 +151,8 @@ if ($DotNet) {
 #endregion
 
 #region PowerShell Module task variables. Find the PowerShell module once.
-if ($PowerShell) {
+if ($PSModuleName) {
     Write-Information "Initializing PSModule build variables"
-    # Any of these variables can be set in the .build.ps1 to override our defaults:
-    # $PSModuleName, $PSModuleSourceRoot,
-    $script:PSModuleName ??= "*"
-
     # We're looking for either a build.psd1 or the module manifest:
     #   .\src\ModuleName.psd1
     #   .\source\ModuleName.psd1
@@ -236,10 +228,6 @@ if ($PowerShell) {
     $script:PSModulePublishUri ??= $Env:PSMODULE_PUBLISH_URI
     $script:PSModulePublishKey ??= $Env:PSMODULE_PUBLISH_KEY
     Write-Information "  PowerShellModulePublishUri: $PowerShellModulePublishUri"
-
-    # THESE variables can't be overridden, they're conventions based on $BuildRoot and $OutputRoot
-    $Script:PSModuleManifestPath = Join-Path $PSModuleOutputPath "$PSModuleName.psd1"
-    Write-Information "  PSModuleManifestPath: $PSModuleManifestPath"
 }
 #endregion