Skip to content

api_function_getgithubactionsstepsummary

hugoalh edited this page Dec 27, 2023 · 7 revisions

Get-GitHubActionsStepSummary

πŸ‘Ž Deprecated

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

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

Get the step summary.

  • # Parameter Set: Content (Default)
    Get-GitHubActionsStepSummary
      [-Raw]
  • # Parameter Set: Size
    Get-GitHubActionsStepSummary
      -Size

Parameter

Raw

[Optional] <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: Content
  • Position: Named
  • Accept Pipeline Input By Property Name: False ❌

Size

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

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

Output

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

Guide

API

Enum

Enum Flag

Function

Function Alias

Clone this wiki locally