Skip to content

Commit

Permalink
fix: Updating Checkout Step to v4 ( Fixes #191 )
Browse files Browse the repository at this point in the history
Updating workflow
  • Loading branch information
StartAutomating authored and StartAutomating committed Sep 15, 2024
1 parent 77d9ea0 commit 3ffefb3
Showing 1 changed file with 24 additions and 73 deletions.
97 changes: 24 additions & 73 deletions docs/Write-ADOError.md
Original file line number Diff line number Diff line change
@@ -1,126 +1,77 @@
Write-ADOError
--------------

### Synopsis
Writes an ADO Error

---

### Description

Writes an Azure DevOps Error

---

### Related Links
* [Write-ADOWarning](Write-ADOWarning.md)



* [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands)



---

### Examples
#### EXAMPLE 1
> EXAMPLE 1
```PowerShell
Write-ADOError "Stuff hit the fan"
```

---

### Parameters
#### **Message**

The error message.

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|true |1 |true (ByPropertyName)|


> **Type**: ```[String]```
> **Required**: true
> **Position**: 1
> **PipelineInput**:true (ByPropertyName)


---
#### **SourcePath**

An optional source path.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|----------------------------|
|`[String]`|false |2 |true (ByPropertyName)|Source<br/>FullName<br/>File|


> **Type**: ```[String]```
> **Required**: false
> **Position**: 2
> **PipelineInput**:true (ByPropertyName)


---
#### **LineNumber**

An optional line number.

|Type |Required|Position|PipelineInput |Aliases|
|----------|--------|--------|---------------------|-------|
|`[UInt32]`|false |3 |true (ByPropertyName)|Line |


> **Type**: ```[UInt32]```
> **Required**: false
> **Position**: 3
> **PipelineInput**:true (ByPropertyName)


---
#### **ColumnNumber**

An optional column number.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|--------------|
|`[UInt32]`|false |4 |true (ByPropertyName)|Column<br/>Col|


> **Type**: ```[UInt32]```
> **Required**: false
> **Position**: 4
> **PipelineInput**:true (ByPropertyName)


---
#### **Code**

An optional error code.



> **Type**: ```[String]```
> **Required**: false
> **Position**: 5
> **PipelineInput**:true (ByPropertyName)

|Type |Required|Position|PipelineInput |
|----------|--------|--------|---------------------|
|`[String]`|false |5 |true (ByPropertyName)|

---

### Outputs
* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String)




---

### Syntax
```PowerShell
Write-ADOError [-Message] <String> [[-SourcePath] <String>] [[-LineNumber] <UInt32>] [[-ColumnNumber] <UInt32>] [[-Code] <String>] [<CommonParameters>]
```
---

0 comments on commit 3ffefb3

Please sign in to comment.