20211228A

Author: hugoalh

.github/workflows/scan-virus.yml

@@ -14,30 +14,41 @@ on:
       - "synchronize"
   workflow_dispatch:
     inputs:
-      gitdepth:
-        description: "{boolean} Also scan Git commits."
+      integrate_git:
+        description: "{boolean} Git integration."
         required: false
         default: "true"
 jobs:
-  depth:
-    name: "Depth Scan"
+  parse-inputs:
+    name: "(Parse Inputs)"
     runs-on: "ubuntu-latest"
-    if: "${{github.event.inputs.gitdepth == 'true'}}"
     steps:
-      - name: "Checkout Repository"
-        uses: "actions/[email protected]"
-        with:
-          fetch-depth: 0
-      - name: "Depth Scan Repository"
-        uses: "hugoalh/[email protected]"
-        with:
-          gitdepth: "true"
-  flat:
-    name: "Flat Scan"
+      - run: |
+          [string]$GitIntegrationInput = '${{github.event.inputs.integrate_git}}'
+          if ($GitIntegrationInput.Length -eq 0) {
+            $GitIntegrationInput = 'false'
+          }
+          [bool]$GitIntegration = [bool]::Parse($GitIntegrationInput)
+          Write-Host -Object "::set-output name=depth::$($GitIntegration ? 0 : 1)"
+          Write-Host -Object "::set-output name=integrate::$($GitIntegration ? 'git' : 'none')"
+          Write-Host -Object "::set-output name=title::$($GitIntegration ? 'Depth' : 'Flat')"
+        id: "parser"
+        shell: "pwsh"
+    outputs:
+      depth: "${{steps.parser.outputs.depth}}"
+      integrate: "${{steps.parser.outputs.integrate}}"
+      title: "${{steps.parser.outputs.title}}"
+  scan-virus:
+    name: "${{needs.parse-inputs.outputs.title}} Scan"
     runs-on: "ubuntu-latest"
-    if: "${{github.event.inputs.gitdepth != 'true'}}"
+    needs:
+      - "parse-inputs"
     steps:
       - name: "Checkout Repository"
         uses: "actions/[email protected]"
-      - name: "Flat Scan Repository"
-        uses: "hugoalh/[email protected]"
+        with:
+          fetch-depth: "${{needs.parse-inputs.outputs.depth}}"
+      - name: "${{needs.parse-inputs.outputs.title}} Scan Repository"
+        uses: "hugoalh/[email protected]"
+        with:
+          integrate: "${{needs.parse-inputs.outputs.integrate}}"

README.md

@@ -21,4 +21,51 @@ A PowerShell module to create GitHub Actions easier.
 
 ## 📚 Documentation
 
-?
+*For the official documentation, please visit [GitHub Repository Wiki](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki).*
+
+### Getting Started
+
+#### Install
+
+PowerShell (>= v7.2.0):
+
+```ps1
+Install-Module -Name 'hugoalh.GitHubActionsToolkit'
+```
+
+#### Use
+
+```ps1
+Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope Local
+```
+
+### Function
+
+- `Add-GHActionsEnvironmentVariable`
+- `Add-GHActionsPATH`
+- `Add-GHActionsSecretMask`
+- `Disable-GHActionsCommandEcho`
+- `Disable-GHActionsProcessingCommand`
+- `Enable-GHActionsCommandEcho`
+- `Enable-GHActionsProcessingCommand`
+- `Enter-GHActionsLogGroup`
+- `Exit-GHActionsLogGroup`
+- `Get-GHActionsInput`
+- `Get-GHActionsIsDebug`
+- `Get-GHActionsState`
+- `Get-GHActionsWebhookEventPayload`
+- `Invoke-GHActionsScriptGroup`
+- `Set-GHActionsOutput`
+- `Set-GHActionsState`
+- `Write-GHActionsDebug`
+- `Write-GHActionsError`
+- `Write-GHActionsFail`
+- `Write-GHActionsNotice`
+- `Write-GHActionsWarning`
+
+### Example
+
+```ps1
+Set-GHActionsOutput -Name 'foo' -Value 'bar'
+#=> ::set-output name=foo::bar
+```

hugoalh.GitHubActionsToolkit.psd1

@@ -73,6 +73,7 @@
 		'Get-GHActionsInput',
 		'Get-GHActionsIsDebug',
 		'Get-GHActionsState',
+		'Get-GHActionsWebhookEventPayload',
 		'Invoke-GHActionsScriptGroup',
 		'Set-GHActionsOutput',
 		'Set-GHActionsState',