0.5.0

🔦 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

0.4.1

• ADD: Added new parameter RequireFailMessage for function Get-GitHubActionsInput
• CHANGE: Improved error messages
• CHANGE: Improved function Add-GitHubActionsProblemMatcher efficiency
• CHANGE: Improved function Get-GitHubActionsOidcToken logic

0.4.0

• ADD: Added new function Get-GitHubActionsOidcToken

  ⚠ Important: This is in experimental!

• CHANGE: Fixed parameters' validations not well implemented at functions Set-GitHubActionsOutput and Set-GitHubActionsState
• CHANGE: Improved error messages, should be less confused than before
• CHANGE: Improved chunks' splitting at function Add-GitHubActionsSecretMask to improve support on non ASCII characters

0.3.4

• CHANGE: Fixed unexpected behaviour on parameters which allow empty string(s)
• CHANGE: Removed pointless and unnecessary brackets in the code

0.3.3

• CHANGE: Added work around fix of missing case insensitive behaviour on the Linux platform

  🤷

0.3.2

• CHANGE: Exceptions triggered by parameter Require now will also show it's error message as annotation
• CHANGE: Fixed incorrect suffix replacement

0.3.1

• ADD: Added new function Get-GitHubActionsStepSummary
• ADD: Added new parameter LiteralPath for function Add-GitHubActionsProblemMatcher
• ADD: Added new parameter NoNewLine for functions Add-GitHubActionsStepSummary and Set-GitHubActionsStepSummary
• CHANGE: Fixed issues on function Remove-GitHubActionsStepSummary
• CHANGE: Improved efficiency on file system I/O

0.3.0

• ADD: Added ability to pipeline parameters to most of the public functions
• ADD: Added ability to skip validation when adding PATH for function Add-GitHubActionsPATH via parameter NoValidator
• ADD: Added depth to parse webhook event payload for function Get-GitHubActionsWebhookEventPayload via parameter Depth
• ADD: Added help URI for module and public functions (which lead to the official wiki)
• ADD: Added new functions:
  • Add-GitHubActionsStepSummary
  • Remove-GitHubActionsStepSummary
  • Set-GitHubActionsStepSummary
  • Test-GitHubActionsEnvironment
• ADD: Added support of summary (via functions Add-GitHubActionsStepSummary, Remove-GitHubActionsStepSummary, and Set-GitHubActionsStepSummary)
• ADD: Changed function Write-GitHubActionsCommand from private to public to service fresh and new commands and/or experimental commands which this module has not included yet
• CHANGE: Fixed display issues on functions' output type
• CHANGE: Fixed enumerate issues when getting webhook event payload
• CHANGE: Fixed function Write-GitHubActionsFail parameters, should equivalent to function Write-GitHubActionsError parameters
• CHANGE: Fixed issues and improved on parameters' validations
• CHANGE: Fixed issues when adding environment variables
• CHANGE: Fixed issues when adding problem matchers
• CHANGE: Fixed output issues on pipeline functions
• CHANGE: Fixed some grammar mistakes
• CHANGE: Improved commands efficiency
• CHANGE: Improved commands formatting efficiency
• CHANGE: Improved restrictions for functions Disable-GitHubActionsProcessingCommands and Enable-GitHubActionsProcessingCommands
• CHANGE: Redesigned functions Get-GitHubActionsInput and Get-GitHubActionsState:
  • Fixed issues when getting some of the inputs
  • No longer support wildcard characters due to the redesign changes
  • Support of name prefix and suffix, no longer duplicated namespaces
• CHANGE: Reduced file system I/O times
• CHANGE: Renamed function Add-GitHubActionsSecretMask parameter Smart to WithChunks for better identification
• CHANGE: Renamed functions (old names now are as alias):
  • Disable-GitHubActionsEchoCommand to Disable-GitHubActionsEchoingCommands
  • Disable-GitHubActionsProcessingCommand to Disable-GitHubActionsProcessingCommands
  • Enable-GitHubActionsEchoCommand to Enable-GitHubActionsEchoingCommands
  • Enable-GitHubActionsProcessingCommand to Enable-GitHubActionsProcessingCommands
• CHANGE: Renamed module prefix from GHActions to GitHubActions (old name now is as alias)
• REMOVE: Removed flag and support of common parameters (pointless in the GitHub Actions environment)

0.2.0

• ADD: Added function output type attributes
• ADD: Added new functions:
  • Add-GHActionsProblemMatcher
  • Remove-GHActionsProblemMatcher
  • Write-GHActionsAnnotation
• ADD: Added parameter AsHashTable for function Get-GHActionsWebhookEventPayload
• ADD: Added "Requires" attributes
• ADD: Added smart mode for function Add-GHActionsSecretMask to use improved method to well make a secret will get masked from the log
• ADD: Functions Set-GHActionsOutput and Set-GHActionsState now also accept hashtable via parameter InputObject
• CHANGE: Fixed $null determine issues
• CHANGE: Fixed /__+/ in functions Get-GHActionsInput and Get-GHActionsState
• CHANGE: Function Add-GHActionsEnvironmentVariable parameter InputObject now only accept hashtable
• CHANGE: Function Disable-GHActionsProcessingCommand now accept custom end token via parameter EndToken
• CHANGE: Function Write-GHActionsFail parameter Message no longer optional
• CHANGE: Functions Write-GHActionsError, Write-GHActionsFail, Write-GHActionsNotice, and Write-GHActionsWarning no longer accept value from pipeline
• CHANGE: Improved enumeration
• CHANGE: Improved error message
• CHANGE: Improved function Add-GHActionsEnvironmentVariable parameter set
• CHANGE: Improved internal functions
• CHANGE: Renamed functions:
  • Disable-GHActionsCommandEcho to Disable-GHActionsEchoCommand
  • Enable-GHActionsCommandEcho to Enable-GHActionsEchoCommand
• CHANGE: Renamed parameter Col to Column
• REMOVE: Removed function Invoke-GHActionsScriptGroup
• REMOVE: Removed JSON depth restriction for function Get-GHActionsWebhookEventPayload

0.1.0

Initial pre-release.