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 9f65f53 commit dd3624a
Showing 1 changed file with 32 additions and 99 deletions.
131 changes: 32 additions & 99 deletions docs/Add-ADOAttachment.md
Original file line number Diff line number Diff line change
@@ -1,164 +1,98 @@
Add-ADOAttachment
-----------------

### Synopsis
Adds an ADO Attachment

---

### Description

Adds an Azure DevOps Attachment

---

### Related Links
* [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
Add-ADOAttachment -Path .\a.zip
```
> EXAMPLE 2
#### EXAMPLE 2
```PowerShell
Add-ADOAttachment -Path .\summary.md -IsSummary
```
> EXAMPLE 3
#### EXAMPLE 3
```PowerShell
Add-ADOAttachment -Path .\log.txt -IsLog
```

---

### Parameters
#### **Path**

The attachment path.

|Type |Required|Position|PipelineInput |Aliases |
|----------|--------|--------|---------------------|--------|
|`[String]`|true |named |true (ByPropertyName)|Fullname|


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


---
#### **Name**

The Attachment name. This is used to upload information for an Azure DevOps extension.

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


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


---
#### **Type**

The Attachment type. This is used to upload information for an Azure DevOps extension.

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


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


---
#### **ContainerFolder**

The Container Folder. This is required when uploading artifacts.

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


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


---
#### **ArtifactName**

The Artifact Name.

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


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


---
#### **IsSummary**

If set, the upload will be treated as a summary. Summary uploads must be markdown.

|Type |Required|Position|PipelineInput |Aliases|
|----------|--------|--------|---------------------|-------|
|`[Switch]`|true |named |true (ByPropertyName)|Summary|


> **Type**: ```[Switch]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **IsLog**

If set, the upload will be treated as a log file.



> **Type**: ```[Switch]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)

|Type |Required|Position|PipelineInput |Aliases|
|----------|--------|--------|---------------------|-------|
|`[Switch]`|true |named |true (ByPropertyName)|Log |

---

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




---

### Syntax
```PowerShell
Add-ADOAttachment -Path <String> [<CommonParameters>]
Expand All @@ -175,4 +109,3 @@ Add-ADOAttachment -Path <String> -IsSummary [<CommonParameters>]
```PowerShell
Add-ADOAttachment -Path <String> [-Name] <String> [-Type] <String> [<CommonParameters>]
```
---

0 comments on commit dd3624a

Please sign in to comment.