-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Updating Checkout Step to v4 ( Fixes #191 )
Updating workflow
- Loading branch information
StartAutomating
authored and
StartAutomating
committed
Sep 15, 2024
1 parent
3b0fba8
commit f4c4c54
Showing
1 changed file
with
55 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,317 +1,174 @@ | ||
| Set-ADOWorkItem | ||
| --------------- | ||
|
|
||
| ### Synopsis | ||
| Sets work items from Azure DevOps | ||
|
|
||
| --- | ||
|
|
||
| ### Description | ||
|
|
||
| Sets work item from Azure DevOps or Team Foundation Server. | ||
|
|
||
| --- | ||
|
|
||
| ### Related Links | ||
| * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) | ||
|
|
||
|
|
||
|
|
||
| * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/update](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/update) | ||
|
|
||
|
|
||
|
|
||
| * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1) | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### Examples | ||
| #### EXAMPLE 1 | ||
| > EXAMPLE 1 | ||
| ```PowerShell | ||
| @{ 'Verb' ='Get' ;'Noun' = 'ADOWorkItem' } | | ||
| Set-ADOWorkItem -Organization StartAutomating -Project PSDevOps -ID 4 | ||
| ``` | ||
| > EXAMPLE 2 | ||
| #### EXAMPLE 2 | ||
| ```PowerShell | ||
| Set-ADOWorkItem -Organization StartAutomating -Project PSDevOps -Query "Select [System.ID] from WorkItems Where [System.State] = 'To Do' and [System.AssignedTo] = @Me" -InputObject @{ | ||
| State = 'Doing' | ||
| } | ||
| ``` | ||
| > EXAMPLE 3 | ||
| #### EXAMPLE 3 | ||
| ```PowerShell | ||
| Set-ADOWorkItem -Organization TestOrg -Project Test -ID 123 -InputObject @{ | ||
| Version = 'Updating Custom Version Field Despite Being Read Only' | ||
| } -PersonalAccessToken $myPat -BypassRule | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Parameters | ||
| #### **InputObject** | ||
|
|
||
| The InputObject | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |------------|--------|--------|------------------------------| | ||
| |`[PSObject]`|false |named |true (ByValue, ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[PSObject]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByValue, ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Organization** | ||
|
|
||
| The Organization | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases| | ||
| |----------|--------|--------|---------------------|-------| | ||
| |`[String]`|true |named |true (ByPropertyName)|Org | | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Project** | ||
|
|
||
| The Project | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|true |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ID** | ||
|
|
||
| The Work Item ID | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|true |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Query** | ||
|
|
||
| A query | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|true |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ParentID** | ||
|
|
||
| The work item ParentID | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Relationship** | ||
|
|
||
| A collection of relationships for the work item. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |---------------|--------|--------|---------------------|-------------| | ||
| |`[IDictionary]`|false |named |true (ByPropertyName)|Relationships| | ||
|
|
||
|
|
||
| > **Type**: ```[IDictionary]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Comment** | ||
|
|
||
| A list of comments to be added to the work item. | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |--------------|--------|--------|---------------------| | ||
| |`[PSObject[]]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[PSObject[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Tag** | ||
|
|
||
| A list of tags to assign to the work item. | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |------------|--------|--------|---------------------| | ||
| |`[String[]]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **BypassRule** | ||
|
|
||
| If set, will not validate rules. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |----------|--------|--------|---------------------|----------------------------------| | ||
| |`[Switch]`|false |named |true (ByPropertyName)|BypassRules<br/>NoRules<br/>NoRule| | ||
|
|
||
|
|
||
| > **Type**: ```[Switch]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ValidateOnly** | ||
|
|
||
| If set, will only validate rules, but will not update the work item. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |----------|--------|--------|---------------------|-----------------------------------------------------------| | ||
| |`[Switch]`|false |named |true (ByPropertyName)|ValidateRules<br/>ValidateRule<br/>CheckRule<br/>CheckRules| | ||
|
|
||
|
|
||
| > **Type**: ```[Switch]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **SupressNotification** | ||
|
|
||
| If set, will only validate rules, but will not update the work item. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |----------|--------|--------|---------------------|-----------------------------------------------------------------------------| | ||
| |`[Switch]`|false |named |true (ByPropertyName)|SuppressNotifications<br/>SkipNotification<br/>SkipNotifications<br/>NoNotify| | ||
|
|
||
|
|
||
| > **Type**: ```[Switch]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Server** | ||
|
|
||
| The server. By default https://dev.azure.com/. | ||
| To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |-------|--------|--------|---------------------| | ||
| |`[Uri]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[Uri]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ApiVersion** | ||
|
|
||
| The api version. By default, 5.1. | ||
| If targeting TFS, this will need to change to match your server version. | ||
| See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops | ||
|
|
||
| |Type |Required|Position|PipelineInput| | ||
| |----------|--------|--------|-------------| | ||
| |`[String]`|false |named |false | | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:false | ||
|
|
||
|
|
||
| --- | ||
| #### **WhatIf** | ||
| -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. | ||
| -WhatIf is used to see what would happen, or return operations without executing them | ||
| #### **Confirm** | ||
| -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. | ||
| -Confirm is used to -Confirm each operation. | ||
|
|
||
| If you pass ```-Confirm:$false``` you will not be prompted. | ||
|
|
||
|
|
||
|
|
||
| If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. | ||
|
|
||
| --- | ||
|
|
||
| ### Outputs | ||
| * PSDevOps.WorkItem | ||
|
|
||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### Syntax | ||
| ```PowerShell | ||
| Set-ADOWorkItem [-InputObject <PSObject>] -Organization <String> -Project <String> -ID <String> [-ParentID <String>] [-Relationship <IDictionary>] [-Comment <PSObject[]>] [-Tag <String[]>] [-BypassRule] [-ValidateOnly] [-SupressNotification] [-Server <Uri>] [-ApiVersion <String>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` | ||
| ```PowerShell | ||
| Set-ADOWorkItem [-InputObject <PSObject>] -Organization <String> -Project <String> -Query <String> [-ParentID <String>] [-Relationship <IDictionary>] [-Comment <PSObject[]>] [-Tag <String[]>] [-BypassRule] [-ValidateOnly] [-SupressNotification] [-Server <Uri>] [-ApiVersion <String>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` | ||
| --- |