20220506A

hugoalh · hugoalh · commit 526d928dbe09 · 2022-05-06T11:13:56.000+08:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,2 +1 @@
-# $<Schema>$ https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners#codeowners-syntax
 * @hugoalh-studio/develop
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
 name: "Bug Report (Form)"
 description: "Report a bug."
 labels:
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,2 +1 @@
-# $<Schema>$ https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
 blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.yml b/.github/ISSUE_TEMPLATE/documentation-issue.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
 name: "Documentation Issue (Form)"
 description: "Report a documentation issue."
 labels:
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
 name: "Feature Request (Form)"
 description: "Suggest an idea."
 labels:
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
 version: 2
 updates:
   - package-ecosystem: "github-actions"
diff --git a/.github/workflows/analyze-code-ghsl.yml b/.github/workflows/analyze-code-ghsl.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "Analyze Code - GitHub Super Linter"
 on:
   push:
@@ -19,7 +18,7 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Checkout Repository"
-        uses: "actions/checkout@v3.0.1"
+        uses: "actions/checkout@v3.0.2"
         with:
           fetch-depth: 0
       - name: "Analyze Repository"
diff --git a/.github/workflows/announce-new-release-discord.yml b/.github/workflows/announce-new-release-discord.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "Announce New Release - Discord"
 on:
   release:
@@ -9,33 +8,25 @@ jobs:
     name: "Announce New Release - Discord"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "hugoalh/send-discord-webhook-ghaction@v4.1.1"
+      - uses: "hugoalh/send-discord-webhook-ghaction@v4.2.0"
         with:
           key: "${{secrets.DISCORDWEBHOOK_HUGOALHSTUDIO_STUDIOANNOUNCEMENT_PROJECTNEWRELEASEANNOUNCER}}"
           payload: |
-            {
-              "embeds": [
-                {
-                  "title": "GitHub Actions Toolkit (PowerShell)",
-                  "description": "Version ${{github.event.release.name}} (${{github.event.release.tag_name}}) is released and available on:",
-                  "color": "44,85,145",
-                  "thumbnail": {
-                    "url": "https://i.imgur.com/PRyLxK8.png"
-                  },
-                  "fields": [
-                    {
-                      "name": "GitHub (& Changelog)",
-                      "value": "${{github.event.release.html_url}}"
-                    },
-                    {
-                      "name": "PowerShell Gallery",
-                      "value": "https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit"
-                    },
-                    {
-                      "name": "Repository",
-                      "value": "${{github.event.repository.html_url}}"
-                    }
-                  ]
-                }
-              ]
-            }
+            content: |
+              **__GitHub Actions Toolkit (PowerShell)__**
+
+              Version ${{github.event.release.name}} (${{github.event.release.tag_name}}) is released and available on:
+
+              - **GitHub Repository Release (& Changelog):** <${{github.event.release.html_url}}>
+              - **PowerShell Gallery:** <https://www.powershellgallery.com/packages/hugoalh.GitHubActionsToolkit>
+            embeds:
+              - description: |
+                  **__GitHub Actions Toolkit (PowerShell)__**
+
+                  ${{github.event.repository.description}}
+
+                  - **GitHub:** ${{github.event.repository.html_url}}
+                color: "44,85,145"
+                thumbnail:
+                  url: "https://i.imgur.com/PRyLxK8.png"
+          wait: "true"
diff --git a/.github/workflows/announce-new-release-ifttt.yml b/.github/workflows/announce-new-release-ifttt.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "Announce New Release - IFTTT"
 on:
   release:
diff --git a/.github/workflows/publish-psg-module.yml b/.github/workflows/publish-psg-module.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "Publish - PowerShell Gallery - Module"
 on:
   release:
@@ -11,7 +10,7 @@ jobs:
     runs-on: "windows-latest"
     steps:
       - name: "Checkout Repository"
-        uses: "actions/checkout@v3.0.1"
+        uses: "actions/checkout@v3.0.2"
       - name: "Modify PowerShell Repository"
         id: "modify-powershell-repository"
         run: |
diff --git a/.github/workflows/scan-virus.yml b/.github/workflows/scan-virus.yml
@@ -1,4 +1,3 @@
-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "Scan Virus"
 on:
   push:
@@ -14,8 +13,8 @@ on:
       - "synchronize"
   workflow_dispatch:
     inputs:
-      integrate_git:
-        description: "{boolean} Git integration."
+      git_deep:
+        description: "{boolean} Scan deeper for Git repository."
         required: false
         default: "true"
 jobs:
@@ -24,31 +23,27 @@ jobs:
     runs-on: "ubuntu-latest"
     steps:
       - run: |
-          [string]$GitIntegrationInput = '${{github.event.inputs.integrate_git}}'
-          if ($GitIntegrationInput.Length -eq 0) {
-            $GitIntegrationInput = 'false'
+          [string]$GitDeep = '${{github.event.inputs.git_deep}}'
+          if ($GitDeep.Length -eq 0) {
+            $GitDeep = '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')"
+          Write-Host -Object "::set-output name=git_deep::$GitDeep"
         id: "parser"
         shell: "pwsh"
     outputs:
-      depth: "${{steps.parser.outputs.depth}}"
-      integrate: "${{steps.parser.outputs.integrate}}"
-      title: "${{steps.parser.outputs.title}}"
+      git_deep: "${{steps.parser.outputs.git_deep}}"
   scan-virus:
-    name: "${{needs.parse-inputs.outputs.title}} Scan"
+    name: "Scan Virus"
     runs-on: "ubuntu-latest"
     needs:
       - "parse-inputs"
     steps:
       - name: "Checkout Repository"
-        uses: "actions/checkout@v3.0.1"
+        uses: "actions/checkout@v3.0.2"
         with:
-          fetch-depth: "${{needs.parse-inputs.outputs.depth}}"
-      - name: "${{needs.parse-inputs.outputs.title}} Scan Repository"
-        uses: "hugoalh/scan-virus-ghaction@v0.4.2"
+          fetch-depth: 0
+      - name: "Scan Repository"
+        uses: "hugoalh/scan-virus-ghaction@v0.6.1"
         with:
-          integrate: "${{needs.parse-inputs.outputs.integrate}}"
+          git_deep: "${{needs.parse-inputs.outputs.git_deep}}"
+          yara_enable: "true"
diff --git a/README.md b/README.md
@@ -42,34 +42,34 @@ Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope Local
 
 ### Function (Excerpt)
 
-- `Add-GHActionsEnvironmentVariable`
-- `Add-GHActionsPATH`
-- `Add-GHActionsProblemMatcher`
-- `Add-GHActionsSecretMask`
-- `Disable-GHActionsEchoCommand`
-- `Disable-GHActionsProcessingCommand`
-- `Enable-GHActionsEchoCommand`
-- `Enable-GHActionsProcessingCommand`
-- `Enter-GHActionsLogGroup`
-- `Exit-GHActionsLogGroup`
-- `Get-GHActionsInput`
-- `Get-GHActionsIsDebug`
-- `Get-GHActionsState`
-- `Get-GHActionsWebhookEventPayload`
-- `Remove-GHActionsProblemMatcher`
-- `Set-GHActionsOutput`
-- `Set-GHActionsState`
-- `Test-GHActionsEnvironment`
-- `Write-GHActionsAnnotation`
-- `Write-GHActionsDebug`
-- `Write-GHActionsError`
-- `Write-GHActionsFail`
-- `Write-GHActionsNotice`
-- `Write-GHActionsWarning`
+- `Add-GitHubActionsEnvironmentVariable`
+- `Add-GitHubActionsPATH`
+- `Add-GitHubActionsProblemMatcher`
+- `Add-GitHubActionsSecretMask`
+- `Disable-GitHubActionsEchoCommand`
+- `Disable-GitHubActionsProcessingCommand`
+- `Enable-GitHubActionsEchoCommand`
+- `Enable-GitHubActionsProcessingCommand`
+- `Enter-GitHubActionsLogGroup`
+- `Exit-GitHubActionsLogGroup`
+- `Get-GitHubActionsInput`
+- `Get-GitHubActionsIsDebug`
+- `Get-GitHubActionsState`
+- `Get-GitHubActionsWebhookEventPayload`
+- `Remove-GitHubActionsProblemMatcher`
+- `Set-GitHubActionsOutput`
+- `Set-GitHubActionsState`
+- `Test-GitHubActionsEnvironment`
+- `Write-GitHubActionsAnnotation`
+- `Write-GitHubActionsDebug`
+- `Write-GitHubActionsError`
+- `Write-GitHubActionsFail`
+- `Write-GitHubActionsNotice`
+- `Write-GitHubActionsWarning`
 
 ### Example (Excerpt)
 
 ```ps1
-Set-GHActionsOutput -Name 'foo' -Value 'bar'
+Set-GitHubActionsOutput -Name 'foo' -Value 'bar'
 #=> ::set-output name=foo::bar
 ```
diff --git a/hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psd1 b/hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psd1
@@ -61,55 +61,101 @@
 
 	# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
 	FunctionsToExport = @(
-		'Add-GHActionsEnvironmentVariable',
-		'Add-GHActionsPATH',
-		'Add-GHActionsProblemMatcher',
-		'Add-GHActionsSecretMask',
-		'Disable-GHActionsEchoCommand',
-		'Disable-GHActionsProcessingCommand',
-		'Enable-GHActionsEchoCommand',
-		'Enable-GHActionsProcessingCommand',
-		'Enter-GHActionsLogGroup',
-		'Exit-GHActionsLogGroup',
-		'Get-GHActionsInput',
-		'Get-GHActionsIsDebug',
-		'Get-GHActionsState',
-		'Get-GHActionsWebhookEventPayload',
-		'Remove-GHActionsProblemMatcher',
-		'Set-GHActionsOutput',
-		'Set-GHActionsState',
-		'Test-GHActionsEnvironment',
-		'Write-GHActionsAnnotation',
-		'Write-GHActionsDebug',
-		'Write-GHActionsError',
-		'Write-GHActionsFail',
-		'Write-GHActionsNotice',
-		'Write-GHActionsWarning'
+		'Add-GitHubActionsEnvironmentVariable',
+		'Add-GitHubActionsPATH',
+		'Add-GitHubActionsProblemMatcher',
+		'Add-GitHubActionsSecretMask',
+		'Disable-GitHubActionsEchoCommand',
+		'Disable-GitHubActionsProcessingCommand',
+		'Enable-GitHubActionsEchoCommand',
+		'Enable-GitHubActionsProcessingCommand',
+		'Enter-GitHubActionsLogGroup',
+		'Exit-GitHubActionsLogGroup',
+		'Get-GitHubActionsInput',
+		'Get-GitHubActionsIsDebug',
+		'Get-GitHubActionsState',
+		'Get-GitHubActionsWebhookEventPayload',
+		'Remove-GitHubActionsProblemMatcher',
+		'Set-GitHubActionsOutput',
+		'Set-GitHubActionsState',
+		'Test-GitHubActionsEnvironment',
+		'Write-GitHubActionsAnnotation',
+		'Write-GitHubActionsCommand',
+		'Write-GitHubActionsDebug',
+		'Write-GitHubActionsError',
+		'Write-GitHubActionsFail',
+		'Write-GitHubActionsNotice',
+		'Write-GitHubActionsWarning'
 	)
 
 	# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 	CmdletsToExport = @()
 
 	# Variables to export from this module
-	VariablesToExport = '*'
+	VariablesToExport = @()
 
 	# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
 	AliasesToExport = @(
 		'Add-GHActionsEnv',
+		'Add-GHActionsEnvironment',
+		'Add-GHActionsEnvironmentVariable',
 		'Add-GHActionsMask',
+		'Add-GHActionsPATH',
+		'Add-GHActionsProblemMatcher',
 		'Add-GHActionsSecret',
+		'Add-GitHubActionsEnv',
+		'Add-GitHubActionsEnvironment',
+		'Add-GitHubActionsMask',
+		'Add-GitHubActionsSecret',
 		'Disable-GHActionsCommandEcho',
 		'Disable-GHActionsCommandProcessing',
+		'Disable-GHActionsEchoCommand',
+		'Disable-GHActionsProcessingCommand',
+		'Disable-GitHubActionsCommandEcho',
+		'Disable-GitHubActionsCommandProcessing',
 		'Enable-GHActionsCommandEcho',
 		'Enable-GHActionsCommandProcessing',
+		'Enable-GHActionsEchoCommand',
+		'Enable-GHActionsProcessingCommand',
+		'Enable-GitHubActionsCommandEcho',
+		'Enable-GitHubActionsCommandProcessing',
 		'Enter-GHActionsGroup',
+		'Enter-GHActionsLogGroup',
+		'Enter-GitHubActionsGroup',
 		'Exit-GHActionsGroup',
+		'Exit-GHActionsLogGroup',
+		'Exit-GitHubActionsGroup',
 		'Get-GHActionsEvent',
+		'Get-GHActionsInput',
+		'Get-GHActionsIsDebug',
 		'Get-GHActionsPayload',
+		'Get-GHActionsState',
+		'Get-GHActionsWebhookEvent',
+		'Get-GHActionsWebhookEventPayload',
+		'Get-GHActionsWebhookPayload',
+		'Get-GitHubActionsEvent',
+		'Get-GitHubActionsPayload',
+		'Get-GitHubActionsWebhookEvent',
+		'Get-GitHubActionsWebhookPayload',
+		'Remove-GHActionsProblemMatcher',
 		'Restore-GHActionsState',
+		'Restore-GitHubActionsState',
 		'Save-GHActionsState',
+		'Save-GitHubActionsState',
+		'Set-GHActionsOutput',
+		'Set-GHActionsState',
+		'Test-GHActionsEnvironment',
+		'Write-GHActionsAnnotation',
+		'Write-GHActionsCommand',
+		'Write-GHActionsDebug',
+		'Write-GHActionsError',
+		'Write-GHActionsFail',
 		'Write-GHActionsNote',
-		'Write-GHActionsWarn'
+		'Write-GHActionsNotice',
+		'Write-GHActionsWarn',
+		'Write-GHActionsWarning',
+		'Write-GitHubActionsNote',
+		'Write-GitHubActionsWarn'
 	)
 
 	# DSC resources to export from this module
@@ -126,10 +172,8 @@
 		PSData = @{
 			# Tags applied to this module. These help with module discovery in online galleries.
 			Tags = @(
-				'action',
-				'actions',
-				'github',
-				'github-action',
+				'gh-actions',
+				'ghactions',
 				'github-actions',
 				'PSEdition_Core',
 				'toolkit'
@@ -162,5 +206,5 @@
 	# HelpInfoURI = ''
 
 	# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
-	# DefaultCommandPrefix = 'GHActions'
+	# DefaultCommandPrefix = ''
 }
diff --git a/hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psm1 b/hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psm1

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners#codeowners-syntax`
`2`	`1`	`* @hugoalh-studio/develop`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms`
`2`	`1`	`name: "Bug Report (Form)"`
`3`	`2`	`description: "Report a bug."`
`4`	`3`	`labels:`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser`
`2`	`1`	`blank_issues_enabled: true`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms`
`2`	`1`	`name: "Documentation Issue (Form)"`
`3`	`2`	`description: "Report a documentation issue."`
`4`	`3`	`labels:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms`
`2`	`1`	`name: "Feature Request (Form)"`
`3`	`2`	`description: "Suggest an idea."`
`4`	`3`	`labels:`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates`
`2`	`1`	`version: 2`
`3`	`2`	`updates:`
`4`	`3`	`- package-ecosystem: "github-actions"`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-# $<Schema>$ https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions`
`2`	`1`	`name: "Announce New Release - IFTTT"`
`3`	`2`	`on:`
`4`	`3`	`release:`