hugoalh-studio / ghactions-toolkit-powershell

A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner machine, and the toolkit for developing GitHub Actions in PowerShell.

GitHub Actions Toolkit (PowerShell)

⚖️ MIT

🗂️

🆙 ()

A PowerShell module to provide a better and easier way for GitHub Actions to communicate with the runner machine, and the toolkit for developing GitHub Actions in PowerShell.

🎯 Target

• PowerShell >= v7.2.0

  💽 Require Software

  • GitHub Actions Runner
  • NodeJS >= v16.13.0 (Optional, for NodeJS based wrapper API)

🔗 Other Edition

• NodeJS
  • actions/toolkit
    • @actions/artifact
    • @actions/cache
    • @actions/core
    • @actions/exec
    • @actions/github
    • @actions/glob
    • @actions/http-client
    • @actions/io
    • @actions/tool-cache

🔰 Usage

1. Install via PowerShell:

   Install-Module -Name 'hugoalh.GitHubActionsToolkit' -AcceptLicense

2. Import at the script (<ScriptName>.ps1):

   Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Scope 'Local'

🧩 API (Excerpt)

ℹ️ Note

For the prettier documentation, can visit via:

• GitHub Repository Wiki

Function

• Add-GitHubActionsPATH
• Add-GitHubActionsProblemMatcher
• Add-GitHubActionsSecretMask
• Add-GitHubActionsSummary
• Add-GitHubActionsSummaryHeader
• Add-GitHubActionsSummaryImage
• Add-GitHubActionsSummaryLink
• Add-GitHubActionsSummarySubscriptText
• Add-GitHubActionsSummarySuperscriptText
• Disable-GitHubActionsStdOutCommandEcho
• Disable-GitHubActionsStdOutCommandProcess
• Enable-GitHubActionsStdOutCommandEcho
• Enable-GitHubActionsStdOutCommandProcess
• Enter-GitHubActionsLogGroup
• Exit-GitHubActionsLogGroup
• Expand-GitHubActionsToolCacheCompressedFile
• Export-GitHubActionsArtifact
• Find-GitHubActionsToolCache
• Get-GitHubActionsArtifact
• Get-GitHubActionsDebugStatus
• Get-GitHubActionsInput
• Get-GitHubActionsOpenIdConnectToken
• Get-GitHubActionsState
• Get-GitHubActionsSummary
• Get-GitHubActionsWebhookEventPayload
• Get-GitHubActionsWorkflowRunUri
• Import-GitHubActionsArtifact
• Invoke-GitHubActionsToolCacheToolDownloader
• Register-GitHubActionsToolCacheDirectory
• Register-GitHubActionsToolCacheFile
• Remove-GitHubActionsProblemMatcher
• Restore-GitHubActionsCache
• Save-GitHubActionsCache
• Set-GitHubActionsEnvironmentVariable
• Set-GitHubActionsOutput
• Set-GitHubActionsState
• Set-GitHubActionsSummary
• Test-GitHubActionsEnvironment
• Write-GitHubActionsDebug
• Write-GitHubActionsError
• Write-GitHubActionsFail
• Write-GitHubActionsNotice
• Write-GitHubActionsWarning

✍️ Example

• Set-GitHubActionsOutput -Name 'foo' -Value 'bar'

• Write-GitHubActionNotice -Message 'Hello, world!'