Skip to content

api_function_getgithubactionssummary

hugoalh edited this page Nov 12, 2023 · 1 revision

Get-GitHubActionsSummary

  • Type: Function
  • In Version: >= v2.0.0

Get the summary that set in the current step.

  • # Parameter Set: Content (Default)
    Get-GitHubActionsSummary
  • # Parameter Set: ContentRaw
    Get-GitHubActionsSummary
      -Raw
  • # Parameter Set: Size
    Get-GitHubActionsSummary
      -Size

Parameter

Raw

<Switch> Whether to ignore newline characters and output the entire contents of a file in one string with the newlines preserved; By default, newline characters in a file are used as delimiters to separate the input into an array of strings.

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

Size

<Switch> Whether to get the size of the summary instead of the contents of the summary.

  • Parameter Set: Size
  • Position: Named
  • Accept Pipeline Input By Property Name: False ❌
  • Alias:
    • Sizes

Output

  • ContentRaw: <String> Summary with the entire contents in one string.
  • Content: <String[]> Summary with the entire contents in multiple strings separated by newline characters.
  • Size: <UInt32> Size of the summary.

Guide

API

Enum

Enum Flag

Function

Function Alias

Clone this wiki locally