Skip to content

Commit fea5341

Browse files
StartAutomatingStartAutomating
authored andcommitted
Updating Write-GitHubWarning.md
1 parent a845c00 commit fea5341

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

docs/Write-GitHubWarning.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
2+
Write-GitHubWarning
3+
-------------------
4+
### Synopsis
5+
Writes an Git Warning
6+
7+
---
8+
### Description
9+
10+
Writes an GitHub Workflow Warning
11+
12+
---
13+
### Related Links
14+
* [Write-GitHubError](Write-GitHubError.md)
15+
* [https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions](https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions)
16+
---
17+
### Examples
18+
#### EXAMPLE 1
19+
```PowerShell
20+
Write-GitHubWarning "Stuff hit the fan"
21+
```
22+
23+
---
24+
### Parameters
25+
#### **Message**
26+
27+
The Warning message.
28+
29+
30+
31+
|Type |Requried|Postion|PipelineInput |
32+
|--------------|--------|-------|---------------------|
33+
|```[String]```|true |1 |true (ByPropertyName)|
34+
---
35+
#### **File**
36+
37+
An optional source path.
38+
39+
40+
41+
|Type |Requried|Postion|PipelineInput |
42+
|--------------|--------|-------|---------------------|
43+
|```[String]```|false |2 |true (ByPropertyName)|
44+
---
45+
#### **Line**
46+
47+
An optional line number.
48+
49+
50+
51+
|Type |Requried|Postion|PipelineInput |
52+
|--------------|--------|-------|---------------------|
53+
|```[UInt32]```|false |3 |true (ByPropertyName)|
54+
---
55+
#### **Col**
56+
57+
An optional column number.
58+
59+
60+
61+
|Type |Requried|Postion|PipelineInput |
62+
|--------------|--------|-------|---------------------|
63+
|```[UInt32]```|false |4 |true (ByPropertyName)|
64+
---
65+
### Outputs
66+
System.String
67+
68+
69+
---
70+
### Syntax
71+
```PowerShell
72+
Write-GitHubWarning [-Message] <String> [[-File] <String>] [[-Line] <UInt32>] [[-Col] <UInt32>] [<CommonParameters>]
73+
```
74+
---
75+
76+

0 commit comments

Comments
 (0)