🩹 [Patch]: Using GitHub-Script action (#3)

## Description

- Using GitHub-Script action

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

.github/workflows/Linter.yml

@@ -27,3 +27,5 @@ jobs:
         uses: super-linter/super-linter/slim@latest
         env:
           GITHUB_TOKEN: ${{ github.token }}
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_YAML_PRETTIER: false

README.md

@@ -1,22 +1,23 @@
-# Template-action
+# Debug
 
-A template repository for GitHub Actions
+Gets debug information about the environment.
 
-Uses all the contexts and environment variables
+Uses all the contexts, environment variables and PowerShell variables and modules.
 
 - [Contexts | GitHub Docs](https://docs.github.com/en/actions/learn-github-actions/contexts)
 - [Variables | GitHub Docs](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables)
 
 ## Usage
 
-### Inputs
-
-### Secrets
-
-### Outputs
-
 ### Example
 
+#### Example 1: Get debug information
+
 ```yaml
-Example here
+jobs:
+  Get-Debug:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Debug
+        uses: PSModule/Debug@v1
 ```

action.yml

@@ -10,7 +10,7 @@ runs:
   using: composite
   steps:
     - name: Debug
-      shell: pwsh
+      uses: PSModule/GitHub-Script@v1
       env:
         CONTEXT_GITHUB: ${{ toJson(github) }}
         CONTEXT_ENV: ${{ toJson(env) }}
@@ -24,6 +24,9 @@ runs:
         CONTEXT_MATRIX: ${{ toJson(matrix) }}
         # CONTEXT_NEEDS: ${{ toJson(needs) }}
         CONTEXT_INPUTS: ${{ toJson(inputs) }}
-      run: |
-        # Debug environment
-        . "$env:GITHUB_ACTION_PATH\scripts\main.ps1" -Verbose
+      with:
+        Debug: true
+        Verbose: true
+        Script: |
+          # Debug environment
+          . "${{ github.action_path }}\scripts\main.ps1" -Verbose

scripts/main.ps1

@@ -1,84 +1,119 @@
 [CmdletBinding()]
 param()
 
-$n = [System.Environment]::NewLine
-
-
 $CONTEXT_GITHUB = $env:CONTEXT_GITHUB | ConvertFrom-Json -Depth 100
-'::group::Context: [GITHUB]'
-$CONTEXT_GITHUB | ConvertTo-Json -Depth 100
 
-'::group::Context: [GITHUB_EVENT]'
-$CONTEXT_GITHUB.event | ConvertTo-Json -Depth 100
+LogGroup 'Context: [GITHUB]' {
+    $CONTEXT_GITHUB | ConvertTo-Json -Depth 100
+}
 
-'::group::Context: [GITHUB_EVENT_ENTERPRISE]'
-$CONTEXT_GITHUB | ConvertTo-Json -Depth 100
+LogGroup 'Context: [GITHUB_EVENT]' {
+    $CONTEXT_GITHUB.event | ConvertTo-Json -Depth 100
+}
 
-'::group::Context: [GITHUB_EVENT_ORGANIZATION]'
-$CONTEXT_GITHUB.event.organization | ConvertTo-Json -Depth 100
+LogGroup 'Context: [GITHUB_EVENT_ENTERPRISE]' {
+    $CONTEXT_GITHUB | ConvertTo-Json -Depth 100
+}
 
-'::group::Context: [GITHUB_EVENT_REPOSITORY]'
-$CONTEXT_GITHUB.event.repository | ConvertTo-Json -Depth 100
+LogGroup 'Context: [GITHUB_EVENT_ORGANIZATION]' {
+    $CONTEXT_GITHUB.event.organization | ConvertTo-Json -Depth 100
+}
 
-'::group::Context: [ENV]'
-$env:CONTEXT_ENV
+LogGroup 'Context: [GITHUB_EVENT_REPOSITORY]' {
+    $CONTEXT_GITHUB.event.repository | ConvertTo-Json -Depth 100
+}
 
-# '::group::Context: [VARS]'
+LogGroup 'Context: [ENV]' {
+    $env:CONTEXT_ENV
+}
+
+# LogGroup 'Context: [VARS]' {
 # $env:CONTEXT_VARS
+# }
 
-'::group::Context: [JOB]'
-$env:CONTEXT_JOB
+LogGroup 'Context: [JOB]' {
+    $env:CONTEXT_JOB
+}
 
-# '::group::Context: [JOBS]'
+# LogGroup 'Context: [JOBS]' {
 # $env:CONTEXT_JOBS
+# }
 
-'::group::Context: [STEPS]'
-$env:CONTEXT_STEPS
+LogGroup 'Context: [STEPS]' {
+    $env:CONTEXT_STEPS
+}
 
-'::group::Context: [RUNNER]'
-$env:CONTEXT_RUNNER
+LogGroup 'Context: [RUNNER]' {
+    $env:CONTEXT_RUNNER
+}
 
-# '::group::Context: [SECRETS]'
+# LogGroup 'Context: [SECRETS]' {
 # $env:CONTEXT_SECRETS
+# }
 
-'::group::Context: [STRATEGY]'
-$env:CONTEXT_STRATEGY
+LogGroup 'Context: [STRATEGY]' {
+    $env:CONTEXT_STRATEGY
+}
 
-'::group::Context: [MATRIX]'
-$env:CONTEXT_MATRIX
+LogGroup 'Context: [MATRIX]' {
+    $env:CONTEXT_MATRIX
+}
 
-# '::group::Context: [NEEDS]'
+# LogGroup 'Context: [NEEDS]' {
 # $env:CONTEXT_NEEDS
-
-'::group::Context: [INPUTS]'
-$env:CONTEXT_INPUTS
-
-"::group::File system at [$pwd]"
-Get-ChildItem -Path . | Select-Object FullName | Sort-Object FullName | Format-Table -AutoSize -Wrap
-
-'::group::Environment Variables'
-Get-ChildItem env: | Where-Object {$_.Name -notlike 'CONTEXT_*'} | Sort-Object Name | Format-Table -AutoSize -Wrap
-
-"::group::PowerShell variables"
-Get-Variable | Where-Object {$_.Name -notlike 'CONTEXT_*'} | Sort-Object Name | Format-Table -AutoSize -Wrap
-
-"::group::PSVersionTable"
-$PSVersionTable | Select-Object *
-
-"::group::ExecutionContext"
-$ExecutionContext | Select-Object *
-
-"::group::Host"
-$Host | Select-Object *
-
-"::group::MyInvocation"
-$MyInvocation | Select-Object *
-
-"::group::PSCmdlet"
-$PSCmdlet | Select-Object *
-
-"::group::PSSessionOption"
-$PSSessionOption | Select-Object *
-
-"::group::PSStyle"
-$PSStyle | Select-Object *
+# }
+LogGroup 'Context: [INPUTS]' {
+    $env:CONTEXT_INPUTS
+}
+
+LogGroup "File system at [$pwd]" {
+    Get-ChildItem -Path . | Select-Object FullName | Sort-Object FullName | Format-Table -AutoSize -Wrap
+}
+
+LogGroup 'Environment Variables' {
+    Get-ChildItem env: | Where-Object { $_.Name -notlike 'CONTEXT_*' } | Sort-Object Name | Format-Table -AutoSize -Wrap
+}
+
+LogGroup 'PowerShell variables' {
+    Get-Variable | Where-Object { $_.Name -notlike 'CONTEXT_*' } | Sort-Object Name | Format-Table -AutoSize -Wrap
+}
+
+LogGroup 'PSVersionTable' {
+    $PSVersionTable | Select-Object * | Format-List
+}
+
+LogGroup 'Installed Modules - List' {
+    $modules = Get-PSResource | Sort-Object -Property Name
+    $modules | Select-Object Name, Version, CompanyName, Author | Format-Table -AutoSize -Wrap
+}
+
+$modules.Name | Select-Object -Unique | ForEach-Object {
+    $name = $_
+    LogGroup "Installed Modules - Details - [$name]" {
+        $modules | Where-Object Name -EQ $name | Select-Object * | Format-List
+    }
+}
+
+LogGroup 'ExecutionContext' {
+    $ExecutionContext | Select-Object * | Format-List
+}
+
+LogGroup 'Host' {
+    $Host | Select-Object * | Format-List
+}
+
+LogGroup 'MyInvocation' {
+    $MyInvocation | Select-Object * | Format-List
+}
+
+LogGroup 'PSCmdlet' {
+    $PSCmdlet | Select-Object * | Format-List
+}
+
+LogGroup 'PSSessionOption' {
+    $PSSessionOption | Select-Object * | Format-List
+}
+
+LogGroup 'PSStyle' {
+    $PSStyle | Select-Object * | Format-List
+}