Skip to content

api_function_writegithubactionsraw

hugoalh edited this page Dec 27, 2023 · 10 revisions

Write-GitHubActionsRaw

πŸ‘Ž Deprecated

This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

  • Type: Function
  • In Version: v0.5.0 ~ v1.7.X

Print anything to the log without accidentally execute any stdout command.

  • Write-GitHubActionsRaw
      [-InputObject] <Any>
      [-GroupTitle <String>]
      [-WriteIf <Boolean>]
      [-PassThru]

Parameter

GroupTitle

[Optional] <String> Title of the log group; This creates an expandable group in the log, and anything are inside this expandable group in the log.

  • Position: Named
  • Accept Pipeline Input: False ❌
  • Accept Pipeline Input By Property Name: False ❌
  • Accept Wildcard Characters: False ❌
  • Alias:
    • GroupHeader
    • Header
    • Title

InputObject

<Any> Item that need to log.

  • Position: 0
  • Accept Pipeline Input: True βœ”οΈ
  • Accept Pipeline Input By Property Name: True βœ”οΈ
  • Alias:
    • Content
    • Input
    • Message
    • Object

PassThru

(>= v1.6.0) [Optional] <Switch> Return the item. By default, this function does not generate any output.

  • Position: Named
  • Accept Pipeline Input By Property Name: False ❌

WriteIf

(>= v1.6.0) [Optional] <Boolean = True> Log item based on specify condition.

  • Position: Named
  • Accept Pipeline Input: False ❌
  • Accept Pipeline Input By Property Name: False ❌

Output

  • <Unknown> When use the parameter PassThru, this function return the item.
  • <Void> By default, this function does not generate any output.

Guide

API

Enum

Enum Flag

Function

Function Alias

Clone this wiki locally