🌟 [Major]: Standalone Module Builder with isolation

.github/workflows/Action-Test.yml

@@ -32,8 +32,8 @@ jobs:
         uses: ./
         with:
           Name: PSModuleTest
-          Path: tests/src
-          ModulesOutputPath: tests/outputs/modules
+          ArtifactName: PSModuleTestDefault
+          WorkingDirectory: tests/srcTestRepo
 
   ActionTestMinimal:
     name: Action-Test - [Minimal]
@@ -49,9 +49,8 @@ jobs:
         uses: ./
         with:
           Name: PSModuleTest
-          Path: tests/srcMinimal
-          ModulesOutputPath: tests/outputs/modules
-          ModuleArtifactName: moduleMinimal
+          ArtifactName: PSModuleTestMinimal
+          WorkingDirectory: tests/srcMinimalTestRepo
 
   ActionTestWithManifest:
     name: Action-Test - [DefaultWithManifest]
@@ -67,6 +66,5 @@ jobs:
         uses: ./
         with:
           Name: PSModuleTest
-          Path: tests/srcWithManifest
-          ModulesOutputPath: tests/outputs/modules
-          ModuleArtifactName: moduleWithManifest
+          ArtifactName: PSModuleTestWithManifest
+          WorkingDirectory: tests/srcWithManifestTestRepo

.github/workflows/Auto-Release.yml

@@ -30,7 +30,5 @@ jobs:
 
       - name: Auto-Release
         uses: PSModule/Auto-Release@v1
-        env:
-          GITHUB_TOKEN: ${{ github.token }} # Used for GitHub CLI authentication
         with:
           IncrementalPrerelease: false

README.md

@@ -25,16 +25,16 @@ This step lets you add custom build logic to process or modify the module conten
 
 ## Usage
 
-| Name                   | Description                                                                                                                                         | Required | Default           |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------- |
-| `Name`                 | Name of the module to process.                                                                                                                      | `false`  |                   |
-| `Path`                 | Path to the folder where the modules are located.                                                                                                   | `false`  | `src`             |
-| `ModulesOutputPath`    | Path to the folder where the built modules are outputted.                                                                                           | `false`  | `outputs/modules` |
-| `ModuleArtifactName`   | Name of the module artifact to upload.                                                                                                              | `false`  | `module`          |
-| `Debug`                | Enable debug output.                                                                                                                                | `false`  | `'false'`         |
-| `Verbose`              | Enable verbose output.                                                                                                                              | `false`  | `'false'`         |
-| `Version`              | Specifies the version of the GitHub module to be installed. The value must be an exact version.                                                     | `false`  |                   |
-| `Prerelease`           | Allow prerelease versions if available.                                                                                                             | `false`  | `'false'`         |
+| Name                | Description                                                                                     | Required | Default           |
+| --------------------| ----------------------------------------------------------------------------------------------- | -------- | ----------------- |
+| `Name`              | Name of the module to process.                                                                  | `false`  |                   |
+| `Path`              | Path to the folder where the modules are located.                                               | `false`  | `src`             |
+| `ModulesOutputPath` | Path to the folder where the built modules are outputted.                                       | `false`  | `outputs/modules` |
+| `Debug`             | Enable debug output.                                                                            | `false`  | `'false'`         |
+| `Verbose`           | Enable verbose output.                                                                          | `false`  | `'false'`         |
+| `Version`           | Specifies the version of the GitHub module to be installed. The value must be an exact version. | `false`  |                   |
+| `Prerelease`        | Allow prerelease versions if available.                                                         | `false`  | `'false'`         |
+| `WorkingDirectory`  | The working directory where the script runs.                                                    | `false`  | `'.'`             |
 
 ## Root module
 

action.yml

@@ -9,16 +9,8 @@ inputs:
   Name:
     description: Name of the module to process.
     required: false
-  Path:
-    description: Path to the folder where the modules are located.
-    required: false
-    default: src
-  ModulesOutputPath:
-    description: Path to the folder where the built modules are outputted.
-    required: false
-    default: outputs/modules
-  ModuleArtifactName:
-    description: Name of the module artifact to upload.
+  ArtifactName:
+    description: Name of the artifact to upload.
     required: false
     default: module
   Debug:
@@ -36,29 +28,36 @@ inputs:
     description: Allow prerelease versions if available.
     required: false
     default: 'false'
+  WorkingDirectory:
+    description: The working directory where the script will run from.
+    required: false
+    default: '.'
 
 runs:
   using: composite
   steps:
+    - name: Install-PSModuleHelpers
+      uses: PSModule/Install-PSModuleHelpers@v1
+
     - name: Run Build-PSModule
       uses: PSModule/GitHub-Script@v1
+      id: build
       env:
-        GITHUB_ACTION_INPUT_Name: ${{ inputs.Name }}
-        GITHUB_ACTION_INPUT_Path: ${{ inputs.Path }}
-        GITHUB_ACTION_INPUT_ModulesOutputPath: ${{ inputs.ModulesOutputPath }}
+        PSMODULE_BUILD_PSMODULE_INPUT_Name: ${{ inputs.Name }}
       with:
         Debug: ${{ inputs.Debug }}
         Prerelease: ${{ inputs.Prerelease }}
         Verbose: ${{ inputs.Verbose }}
         Version: ${{ inputs.Version }}
+        WorkingDirectory: ${{ inputs.WorkingDirectory }}
         Script: |
           # Build-PSModule
-          ${{ github.action_path }}\scripts\main.ps1
+          ${{ github.action_path }}/scripts/main.ps1
 
     - name: Upload module artifact
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ inputs.ModuleArtifactName }}
-        path: ${{ inputs.ModulesOutputPath }}
+        name: ${{ inputs.ArtifactName }}
+        path: ${{ fromJson(steps.build.outputs.result).moduleOutputFolderPath }}
         if-no-files-found: error
         retention-days: 1

scripts/helpers/Build-PSModule.ps1

@@ -6,6 +6,7 @@
         .DESCRIPTION
         Builds a module.
     #>
+    [OutputType([void])]
     [CmdletBinding()]
     #Requires -Modules @{ ModuleName = 'GitHub'; ModuleVersion = '0.13.2' }
     #Requires -Modules @{ ModuleName = 'Utilities'; ModuleVersion = '0.3.0' }
@@ -28,26 +29,22 @@
 
         # Path to the folder where the built modules are outputted.
         [Parameter(Mandatory)]
-        [string] $ModulesOutputFolderPath
+        [string] $ModuleOutputFolderPath
     )
 
     LogGroup "Building module [$ModuleName]" {
-        Write-Host "Source path:          [$ModuleSourceFolderPath]"
-        if (-not (Test-Path -Path $ModuleSourceFolderPath)) {
-            Write-Error "Source folder not found at [$ModuleSourceFolderPath]"
-            exit 1
-        }
         $moduleSourceFolder = Get-Item -Path $ModuleSourceFolderPath
-        Write-Host "Module source folder: [$moduleSourceFolder]"
-
-        $moduleOutputFolder = New-Item -Path $ModulesOutputFolderPath -Name $ModuleName -ItemType Directory -Force
-        Write-Host "Module output folder: [$moduleOutputFolder]"
+        $moduleOutputFolder = New-Item -Path $ModuleOutputFolderPath -Name $ModuleName -ItemType Directory -Force
+        [pscustomobject]@{
+            ModuleSourceFolderPath = $moduleSourceFolder
+            ModuleOutputFolderPath = $moduleOutputFolder
+        } | Format-List | Out-String
     }
 
     Build-PSModuleBase -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -ModuleOutputFolder $moduleOutputFolder
     Build-PSModuleManifest -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
     Build-PSModuleRootModule -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
-    Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleOutputFolder $moduleOutputFolder
+    Update-PSModuleManifestAliasesToExport -ModuleName $ModuleName -ModuleSourceFolder $moduleSourceFolder -ModuleOutputFolder $moduleOutputFolder
 
     LogGroup 'Build manifest file - Final Result' {
         $outputManifestPath = Join-Path -Path $ModuleOutputFolder -ChildPath "$ModuleName.psd1"

scripts/helpers/Build/Build-PSModuleBase.ps1

@@ -35,12 +35,14 @@
     )
 
     LogGroup 'Build base' {
-        Write-Host "Copying files from [$ModuleSourceFolder] to [$ModuleOutputFolder]"
-        Copy-Item -Path "$ModuleSourceFolder\*" -Destination $ModuleOutputFolder -Recurse -Force -Verbose -Exclude "$ModuleName.psm1"
-        New-Item -Path $ModuleOutputFolder -Name "$ModuleName.psm1" -ItemType File -Force -Verbose
+        $relModuleSourceFolder = $ModuleSourceFolder | Resolve-Path -Relative
+        $relModuleOutputFolder = $ModuleOutputFolder | Resolve-Path -Relative
+        Write-Host "Copying files from [$relModuleSourceFolder] to [$relModuleOutputFolder]"
+        Copy-Item -Path "$ModuleSourceFolder\*" -Destination $ModuleOutputFolder -Recurse -Force -Exclude "$ModuleName.psm1"
+        $null = New-Item -Path $ModuleOutputFolder -Name "$ModuleName.psm1" -ItemType File -Force
     }
 
     LogGroup 'Build base - Result' {
-        (Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force).FullName | Sort-Object
+        Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force | Resolve-Path -Relative | Sort-Object
     }
 }

scripts/helpers/Build/Build-PSModuleManifest.ps1

@@ -363,6 +363,7 @@
         $manifestTags = [System.Collections.Generic.List[string]]::new()
         $tags = $PSData.Keys -contains 'Tags' ? ($PSData.Tags).Count -gt 0 ? $PSData.Tags : $repoLabels : $repoLabels
         $tags | ForEach-Object { $manifestTags.Add($_) }
+        'Windows', 'Linux', 'MacOS' | ForEach-Object { $manifestTags.Add($_) }
         # Add tags for compatability mode. https://docs.microsoft.com/en-us/powershell/scripting/developer/module/how-to-write-a-powershell-module-manifest?view=powershell-7.1#compatibility-tags
         if ($manifest.CompatiblePSEditions -contains 'Desktop') {
             if ($manifestTags -notcontains 'PSEdition_Desktop') {
@@ -448,7 +449,7 @@
     }
 
     LogGroup 'Build manifest file - Format' {
-        Set-ModuleManifest -Path $outputManifestPath -Verbose
+        Set-ModuleManifest -Path $outputManifestPath
     }
 
     LogGroup 'Build manifest file - Result - After format' {
@@ -460,6 +461,6 @@
     }
 
     LogGroup 'Build manifest file - Validate - Test manifest file' {
-        Test-ModuleManifest -Path $outputManifestPath
+        Test-ModuleManifest -Path $outputManifestPath | Format-List | Out-String
     }
 }

scripts/helpers/Build/Build-PSModuleRootModule.ps1

@@ -115,7 +115,7 @@ foreach ($Type in $ExportableClasses) {
 # Remove type accelerators when the module is removed.
 $MyInvocation.MyCommand.ScriptBlock.Module.OnRemove = {
     foreach ($Type in ($ExportableEnums + $ExportableClasses)) {
-        $TypeAcceleratorsClass::Remove($Type.FullName)
+        $null = $TypeAcceleratorsClass::Remove($Type.FullName)
     }
 }.GetNewClosure()
 #endregion Class exporter
@@ -130,10 +130,21 @@ $MyInvocation.MyCommand.ScriptBlock.Module.OnRemove = {
         $exports.Add('Function', (Get-PSModuleFunctionsToExport -SourceFolderPath $ModuleOutputFolder))
         $exports.Add('Variable', (Get-PSModuleVariablesToExport -SourceFolderPath $ModuleOutputFolder))
 
-        Write-Host ($exports | Out-String)
+        [pscustomobject]$exports | Format-List | Out-String
         #endregion - Analyze source files
 
         #region - Module header
+        Add-Content -Path $rootModuleFile -Force -Value @'
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSAvoidAssignmentToAutomaticVariable', 'IsWindows',
+    Justification = 'IsWindows doesnt exist in PS5.1'
+)]
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute(
+    'PSUseDeclaredVarsMoreThanAssignments', 'IsWindows',
+    Justification = 'IsWindows doesnt exist in PS5.1'
+)]
+'@
+
         $headerFilePath = Join-Path -Path $ModuleOutputFolder -ChildPath 'header.ps1'
         if (Test-Path -Path $headerFilePath) {
             Get-Content -Path $headerFilePath -Raw | Add-Content -Path $rootModuleFile -Force
@@ -149,10 +160,15 @@ param()
         #region - Module post-header
         Add-Content -Path $rootModuleFile -Force -Value @'
 $baseName = [System.IO.Path]::GetFileNameWithoutExtension($PSCommandPath)
-$script:PSModuleInfo = Test-ModuleManifest -Path "$PSScriptRoot\$baseName.psd1"
+$script:PSModuleInfo = Import-PowerShellDataFile -Path "$PSScriptRoot\$baseName.psd1"
 $script:PSModuleInfo | Format-List | Out-String -Stream | ForEach-Object { Write-Debug $_ }
 $scriptName = $script:PSModuleInfo.Name
 Write-Debug "[$scriptName] - Importing module"
+
+if ($PSEdition -eq 'Desktop') {
+    $IsWindows = $true
+}
+
 '@
         #endregion - Module post-header
 
@@ -224,7 +240,7 @@ Write-Debug "[`$scriptName] - $relativePath - Done"
 
         $exportsString = $exports | Format-Hashtable
 
-        Write-Host ($exportsString | Out-String)
+        $exportsString | Out-String
 
         $params = @{
             Path  = $rootModuleFile
@@ -256,12 +272,11 @@ Export-ModuleMember @exports
         Write-Host (Show-FileContent -Path $rootModuleFile)
     }
 
-    LogGroup 'Build root module - Validate - Import' {
-        Add-PSModulePath -Path (Split-Path -Path $ModuleOutputFolder -Parent)
-        Import-PSModule -Path $ModuleOutputFolder -ModuleName $ModuleName
-    }
+    # LogGroup 'Build root module - Validate - Import' {
+    #     Install-PSModule -Path $ModuleOutputFolder
+    # }
 
-    LogGroup 'Build root module - Validate - File list' {
-        (Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force).FullName | Sort-Object
-    }
+    # LogGroup 'Build root module - Validate - File list' {
+    #     Get-ChildItem -Path $ModuleOutputFolder -Recurse -Force | Resolve-Path -Relative | Sort-Object
+    # }
 }