Skip to content

0.5.0
Compare
Choose a tag to compare
@hugoalh hugoalh released this 04 Jul 08:21
· 399 commits to main since this release
v0.5.0
edf0938

🔦 Spotlight

Artifact, Cache, & Tool Cache

Previously, if need to manage artifact, cache, and/or tool cache, multiple steps are require to create in the workflow, which maybe cause issues if user forgot to update the require values between different versions, from now on these are controllable in the same step via the NodeJS wrapper APIs.

🧪 Experimental: This is in testing, maybe available in the latest version and/or future version..

Changeable Prefix

In order to avoid name conflicts that maybe occur when different members in the session have the same name, this module is now officially support to change function noun prefix during using Import-Module:

Import-Module -Name 'hugoalh.GitHubActionsToolkit' -Prefix 'GitHubActions' -Scope 'Local'
  • ADD: Added ability to change function noun prefix (default to GitHubActions)
  • ADD: Added new functions:
    • Add-GitHubActionsStepSummaryHeader
    • Add-GitHubActionsStepSummaryImage
    • Add-GitHubActionsStepSummaryLink
    • Add-GitHubActionsStepSummarySubscriptText
    • Add-GitHubActionsStepSummarySuperscriptText
    • Expand-GitHubActionsToolCacheCompressedFile
    • Export-GitHubActionsArtifact
    • Find-GitHubActionsToolCache
    • Get-GitHubActionsWorkflowRunUri
    • Import-GitHubActionsArtifact
    • Invoke-GitHubActionsToolCacheToolDownloader
    • Register-GitHubActionsToolCacheDirectory
    • Register-GitHubActionsToolCacheFile
    • Restore-GitHubActionsCache
    • Save-GitHubActionsCache
    • Test-GitHubActionsNodeJsEnvironment
    • Write-GitHubActionsRaw
  • ADD: Added NodeJS wrapper API dependencies:
    • @actions/artifact
    • @actions/cache
    • @actions/core
    • @actions/tool-cache
  • CHANGE: Changed most of the non mandatory parameters' position to "Named"
  • CHANGE: Fixed function Add-GitHubActionsProblemMatcher maybe cause issues on resolving paths
  • CHANGE: Fixed function Get-GitHubActionsIsDebug maybe report status incorrectly
  • CHANGE: Fixed functions common parameters support (as hidden)
  • CHANGE: Fixed functions that depend on environment variables maybe raise meanless errors, and maybe cause more issues due to missing require environment variables
  • CHANGE: Fixed functions Disable-GitHubActionsProcessingCommands and Enable-GitHubActionsProcessingCommands maybe cause issues by some special end tokens
  • CHANGE: Fixed functions Get-GitHubActionsInput and Get-GitHubActionsState maybe output weird result
  • CHANGE: Fixed module sometimes ignore PowerShell error action preference
  • CHANGE: Fixed some of the parameters' validation that incorrectly accept invalid values and reject valid values
  • CHANGE: Formatted all of the codes with improved PowerShell code guideline
  • CHANGE: Functions Add-GitHubActionsPATH and Set-GitHubActionsEnvironmentVariable (previously named Add-GitHubActionsEnvironmentVariable) are now have correct behaviour to add/set in both scope (i.e.: "Current" and "Subsequent"), equivalent to GitHub Actions official toolkit behaviour, modify this behaviour via parameter Scope
  • CHANGE: Improved function Add-GitHubActionsSecretMask chunk method
  • CHANGE: Improved function Test-GitHubActionsEnvironment, and wide range of usage to early raise issues while execute in incorrect environment, also with mandatory message support (parameter MandatoryMessage)
  • CHANGE: Improved some of the functions pipeline behaviour
  • CHANGE: Refactored all of the codes to module system
  • CHANGE: Renamed function Add-GitHubActionsEnvironmentVariable to Set-GitHubActionsEnvironmentVariable to avoid confusion
  • CHANGE: Renamed function Get-GitHubActionsOidcToken to Get-GitHubActionsOpenIdConnectToken (old name as alias)
  • CHANGE: Renamed parameter RequireFailMessage to MandatoryMessage to avoid confusion
  • CHANGE: Word "Mandatory" is used instead of word "Require" and/or "Required"
  • REMOVE: Removed functions aliases that noun start with GHActions (replaced by changeable prefix)
  • REMOVE: Removed some of the parameters' aliases to avoid confusion
Assets 2
Loading