feat: add Initialize-PSModule action with README and main script

Author: MariusStorhaug

.github/actions/Initialize-PSModule/README.md

@@ -0,0 +1,78 @@
+# Initialize-PSModule
+
+An action that is used to prepare the runner for PSModule framework.
+
+This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the [Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.
+
+## Specifications and practices
+
+Initialize-PSModule follows:
+
+- [SemVer 2.0.0 specifications](https://semver.org)
+- [GitHub Flow specifications](https://docs.github.com/en/get-started/using-github/github-flow)
+- [Continuous Delivery practices](https://en.wikipedia.org/wiki/Continuous_delivery)
+
+... and supports the following practices in the PSModule framework:
+
+- [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself)
+
+## How it works
+
+The Initialize-PSModule action will prepare the runner for the PSModule framework by installing the following dependencies:
+
+| Module | Description |
+| --- | --- |
+| GitHub | Used to interact with the GitHub API and GitHub Action workflow commands. |
+| PSScriptAnalyzer | Used to lint and format PowerShell code. |
+| PSSemVer | Used to create an object for the semantic version numbers. Has functionality to compare, and bump versions. |
+| Pester | Used for testing PowerShell code. |
+| Utilities | Used by all actions, contains common function and classes. |
+| platyPS | Used to generate Markdown documentation from PowerShell code. |
+| powershell-yaml | Used to parse and serialize YAML files, typically for reading configuration files. |
+
+## Usage
+
+### Inputs
+
+| Name | Description | Required | Default |
+| - | - | - | - |
+| `Debug` | Enable debug output. | `false` | `'false'` |
+| `Verbose` | Enable verbose output. | `false` | `'false'` |
+| `Version` | Specifies the version of the GitHub module to be installed. Accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)'). | `false` | |
+| `Prerelease` | Allow prerelease versions if available. | `false` | `'false'` |
+| `WorkingDirectory` | The working directory where the script runs. | `false` | `${{ github.workspace }}` |
+
+## Example
+
+The action can be used in a workflow to prepare the runner for the PSModule framework by adding it at the start of the workflow.
+
+```yaml
+name: Process-PSModule
+
+on: [push]
+
+jobs:
+  Process-PSModule:
+    name: Process module
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Initialize environment
+        uses: PSModule/Initialize-PSModule@main
+```
+
+## Permissions
+
+The action does not require any permissions.
+
+## Compatibility
+
+The action is compatible with the following configurations:
+
+| OS | Shell |
+| --- | --- |
+| windows-latest | pwsh |
+| macos-latest | pwsh |
+| ubuntu-latest | pwsh |

.github/actions/Initialize-PSModule/action.yml

@@ -0,0 +1,42 @@
+name: Initialize-PSModule (by PSModule)
+description: Prepare runner for the PSModule framework.
+author: PSModule
+branding:
+  icon: loader
+  color: gray-dark
+
+inputs:
+  Debug:
+    description: Enable debug output.
+    required: false
+    default: 'false'
+  Verbose:
+    description: Enable verbose output.
+    required: false
+    default: 'false'
+  Version:
+    description: Specifies the version of the GitHub module to be installed. Accepts an exact version or a NuGet version range (for example '[1.2.0, 2.0.0)').
+    required: false
+  Prerelease:
+    description: Allow prerelease versions if available.
+    required: false
+    default: 'false'
+  WorkingDirectory:
+    description: The working directory where the script will run from.
+    required: false
+    default: ${{ github.workspace }}
+
+runs:
+  using: composite
+  steps:
+    - name: Initialize-PSModule
+      uses: PSModule/GitHub-Script@8083ec1f733f00357ee4d0db0c6056686e483bc0 # v1.9.0
+      with:
+        Debug: ${{ inputs.Debug }}
+        Prerelease: ${{ inputs.Prerelease }}
+        Verbose: ${{ inputs.Verbose }}
+        Version: ${{ inputs.Version }}
+        WorkingDirectory: ${{ inputs.WorkingDirectory }}
+        Script: |
+          # Initialize-PSModule
+          ${{ github.action_path }}/src/main.ps1

.github/actions/Initialize-PSModule/src/main.ps1

@@ -0,0 +1,47 @@
+#Requires -Modules GitHub
+
+[CmdletBinding()]
+param()
+
+$requiredModules = @{
+    Utilities         = @{}
+    Retry             = @{}
+    'powershell-yaml' = @{}
+    PSSemVer          = @{}
+    Pester            = @{}
+    PSScriptAnalyzer  = @{}
+    PlatyPS           = @{}
+    MarkdownPS        = @{}
+    Hashtable         = @{}
+    # 'Microsoft.PowerShell.PlatyPS' = @{
+    #     Prerelease = $true
+    # }
+}
+
+$requiredModules.GetEnumerator() | Sort-Object | ForEach-Object {
+    $name = $_.Key
+    $settings = $_.Value
+    LogGroup "Installing prerequisite: [$name]" {
+        $Count = 5
+        $Delay = 10
+        for ($i = 1; $i -le $Count; $i++) {
+            try {
+                Install-PSResource -Name $name -TrustRepository -Repository PSGallery @settings
+                break
+            } catch {
+                if ($i -eq $Count) {
+                    throw $_
+                }
+                Start-Sleep -Seconds $Delay
+            }
+        }
+        Write-Output "Installed module: [$name]"
+        Get-PSResource -Name $name | Select-Object * | Out-String
+
+        Write-Output 'Module commands:'
+        Get-Command -Module $name | Out-String
+    }
+}
+
+Get-InstalledPSResource -Verbose:$false | Sort-Object -Property Name |
+    Format-Table -Property Name, Version, Prerelease, Repository -AutoSize | Out-String