Skip to content

Commit a845c00

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating Write-GitHubOutput.md
1 parent 4441156 commit a845c00

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

docs/Write-GitHubOutput.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
2+
Write-GitHubOutput
3+
------------------
4+
### Synopsis
5+
Writes Git Output
6+
7+
---
8+
### Description
9+
10+
Writes formal Output to a GitHub step.
11+
12+
This output can be referenced in subsequent steps.
13+
14+
---
15+
### Related Links
16+
* [Write-GitHubError](Write-GitHubError.md)
17+
---
18+
### Examples
19+
#### EXAMPLE 1
20+
```PowerShell
21+
Write-GitHubOutput @{
22+
key = 'value'
23+
}
24+
```
25+
26+
#### EXAMPLE 2
27+
```PowerShell
28+
Get-Random -Minimum 1 -Maximum 10 | Write-GitHubHubOutput -Name RandomNumber
29+
```
30+
31+
---
32+
### Parameters
33+
#### **InputObject**
34+
35+
The InputObject. Values will be converted to a JSON array.
36+
37+
38+
39+
|Type |Requried|Postion|PipelineInput |
40+
|----------------|--------|-------|--------------|
41+
|```[PSObject]```|true |1 |true (ByValue)|
42+
---
43+
#### **Name**
44+
45+
The Name of the Output. By default, 'Output'.
46+
47+
48+
49+
|Type |Requried|Postion|PipelineInput|
50+
|--------------|--------|-------|-------------|
51+
|```[String]```|false |2 |false |
52+
---
53+
#### **Depth**
54+
55+
The JSON serialization depth. By default, 10 levels.
56+
57+
58+
59+
|Type |Requried|Postion|PipelineInput|
60+
|-------------|--------|-------|-------------|
61+
|```[Int32]```|false |3 |false |
62+
---
63+
### Outputs
64+
System.String
65+
66+
67+
---
68+
### Syntax
69+
```PowerShell
70+
Write-GitHubOutput [-InputObject] <PSObject> [[-Name] <String>] [[-Depth] <Int32>] [<CommonParameters>]
71+
```
72+
---
73+
74+

0 commit comments

Comments
 (0)