lib/Builds.ps1
|
<# .SYNOPSIS Gets a team project build definitions. .DESCRIPTION This cmdlet will return a list of build definitions or a single build definition if Id or Name is specified. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Project The name of the project to create the new release in. .PARAMETER Id The id of the Build Definition to return. .PARAMETER Name The Name of the Build Definition to return. .PARAMETER Top The maximum number of Build Definitions to return. .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' Get-VstsBuildDefinition ` -Session $vstsSession ` -Project 'FabrikamFiber' Return all build definitions in the project FabrikamFiber. .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' Get-VstsBuildDefinition ` -Session $vstsSession ` -Project 'FabrikamFiber' ` -Name 'Main-CI' Returns the build definition with the name 'Main-CI' .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' Get-VstsBuildDefinition ` -Session $vstsSession ` -Project 'FabrikamFiber' ` -Id 203 Returns the build definition with the Id 203. #> function Get-VstsBuildDefinition { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter(Mandatory = $true)] [String] $Project, [Parameter()] [Int32] $Id, [Parameter()] [String] $Name, [Parameter()] [Int32] $Top ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } $path = 'build/definitions' $additionalInvokeParameters = @{} if ($PSBoundParameters.ContainsKey('Id')) { $path = ('{0}/{1}' -f $path, $Id) } else { $additionalInvokeParameters = @{ QueryStringParameters = Get-VstsQueryStringParametersFromBound ` -BoundParameters $PSBoundParameters ` -ParameterList 'name' QueryStringExtParameters = Get-VstsQueryStringParametersFromBound ` -BoundParameters $PSBoundParameters ` -ParameterList 'Top' } } $result = Invoke-VstsEndpoint ` -Session $Session ` -Project $Project ` -Path $path ` -ApiVersion '2.0' ` @additionalInvokeParameters return $result.Value } <# .SYNOPSIS Create a new build definition for the specified project. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Project The name of the project to create the build in. .PARAMETER Name The name of build definition to create. .PARAMETER DisplayName The display name of build definition to create. .PARAMETER Comment The comment to record against the initial build definition creation. .PARAMETER Queue The name or id of the build queue Queue to use to build the defnition. .PARAMETER Repository The repository object retrieved using Get-VstsGitRepository to link to the build .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' $repository = Get-VstsGitRepository ` -Session $vstsSession ` -Project 'FabrikamFiber' ` -Repository 'FabrikamFiber' New-VstsBuildDefinition ` -Session $vstsSession ` -Project 'FabrikamFiber' ` -Name 'FabrikamFiber-CIX' ` -DisplayName 'Build Fabrikam Fiber' ` -Queue 'Hosted VS2017' ` -Repository $repository #> function New-VstsBuildDefinition { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter(Mandatory = $true)] [String] $Project, [Parameter(Mandatory = $true)] [String] $Name, [Parameter()] [String] $DisplayName = $Name, [Parameter()] [String] $Comment, [Parameter(Mandatory = $true)] $Queue, [Parameter(Mandatory = $true)] [PSCustomObject] $Repository, [Parameter(Mandatory = $false)] [string]$BuildNumberFormat, [Parameter(Mandatory = $false)] [switch]$BadgeEnabled ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } $path = 'build/definitions' if ($Queue -is [String]) { $queueId = (Get-VstsBuildQueue -Session $Session -Name $Queue).Id } else { $queueId = $Queue } $body = @{ name = $Name type = "build" quality = "definition" queue = @{ id = $queueId } build = @( @{ enabled = $true continueOnError = $false alwaysRun = $false displayName = $DisplayName task = @{ id = "71a9a2d3-a98a-4caa-96ab-affca411ecda" versionSpec = "*" } inputs = @{ solution = "**\\*.sln" msbuildArgs = "" platform = '$(platform)' configuration = '$(config)' clean = "false" restoreNugetPackages = "true" vsLocationMethod = "version" vsVersion = "latest" vsLocation = "" msbuildLocationMethod = "version" msbuildVersion = "latest" msbuildArchitecture = "x86" msbuildLocation = "" logProjectEvents = "true" } }, @{ enabled = $true continueOnError = $false alwaysRun = $false displayName = "Test Assemblies **\\*test*.dll;-:**\\obj\\**" task = @{ id = "ef087383-ee5e-42c7-9a53-ab56c98420f9" versionSpec = "*" } inputs = @{ testAssembly = "**\\*test*.dll;-:**\\obj\\**" testFiltercriteria = "" runSettingsFile = "" codeCoverageEnabled = "true" otherConsoleOptions = "" vsTestVersion = "14.0" pathtoCustomTestAdapters = "" } } ) repository = @{ id = $Repository.Id type = "tfsgit" name = $Repository.Name localPath = "`$(sys.sourceFolder)/$($Repository.Name)" defaultBranch = "refs/heads/master" url = $Repository.Url clean = "false" } options = @( @{ enabled = $true definition = @{ id = "7c555368-ca64-4199-add6-9ebaf0b0137d" } inputs = @{ parallel = "false" multipliers = '["config", "platform"]' } } ) variables = @{ forceClean = @{ value = "false" allowOverride = $true } config = @{ value = "debug, release" allowOverride = $true } platform = @{ value = "any cpu" allowOverride = $true } } badgeEnabled = [bool]$BadgeEnabled buildNumberFormat = $BuildNumberFormat triggers = @() comment = $Comment } | ConvertTo-Json -Depth 20 $result = Invoke-VstsEndpoint ` -Session $Session ` -Project $Project ` -Path $path ` -ApiVersion '2.0' ` -Method 'POST' ` -Body $body return $result.Value } <# .SYNOPSIS Gets team project builds. .DESCRIPTION This cmdlet will return a list of builds or a single build if Id is specified. It can also be provided with additional query parmeters to allow additional filters to be applied. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Project The name of the project to get the builds from. .PARAMETER Id The Id of the build to retrieve. .PARAMETER Definitions Get builds matching any of these definitions. .PARAMETER Queues Get builds in any of these queues. .PARAMETER RequestedFor Get build requested by this user. .PARAMETER ReasonFilter Gets builds that were created for this reason. .PARAMETER ResultFilter Gets builds that have this result. .PARAMETER StatusFilter Gets builds that were match this status. .PARAMETER Top The maximum number of builds to return. #> function Get-VstsBuild { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter(Mandatory = $True)] [String] $Project, [Parameter()] [Int32] $Id, [Parameter()] [Int32[]] $Definitions, [Parameter()] [Int32[]] $Queues, [Parameter()] [String] $RequestedFor, [Parameter()] [ValidateSet('Manual', 'IndividualCI', 'BatchedCI', 'Schedule', 'UserCreated', 'ValidateShelveset', 'CheckInShelveset', 'Triggered', 'All')] [String] $ReasonFilter, [Parameter()] [ValidateSet('Succeeded', 'PartiallySucceeded', 'Failed', 'Canceled')] [String] $ResultFilter, [Parameter()] [ValidateSet('InProgress', 'Completed', 'Cancelling', 'Postponed', 'NotStarted', 'All')] [String] $StatusFilter, [Parameter()] [Int32] $Top ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } $path = 'build/builds' $additionalInvokeParameters = @{} if ($PSBoundParameters.ContainsKey('Id')) { $path = ('{0}/{1}' -f $path, $Id) } else { $PSBoundParameters['Definitions'] = ($PSBoundParameters['Definitions'] -join ',') $PSBoundParameters['Queues'] = ($PSBoundParameters['Queues'] -join ',') $additionalInvokeParameters = @{ QueryStringParameters = Get-VstsQueryStringParametersFromBound ` -BoundParameters $PSBoundParameters ` -ParameterList 'definitions', 'queues', 'requestedFor', 'reasonFilter', 'resultFilter', 'statusFilter' QueryStringExtParameters = Get-VstsQueryStringParametersFromBound ` -BoundParameters $PSBoundParameters ` -ParameterList 'top' } } $Result = Invoke-VstsEndpoint ` -Session $Session ` -Project $Project ` -Path $path ` -ApiVersion '2.0' ` @additionalInvokeParameters return $Result.Value } <# .SYNOPSIS Gets team project build artifacts. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Project The name of the project to get the build artifacts from. .PARAMETER BuildId The BuildId of the artifacts to return. .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' $build = Get-VstsBuild ` -Session $Session ` -Project 'FabrikamFiber' ` -Top 1 Get-VstsBuildArtifact ` -Session $Session ` -Project 'FabrikamFiber' ` -BuildId ($build.Id) Get all the build artifacts from the latest build in project FabrikamFiber. #> function Get-VstsBuildArtifact { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter(Mandatory = $true)] [String] $Project, [Parameter(Mandatory = $true)] [Int32] $BuildId ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } $path = ('build/builds/{0}/artifacts' -f $BuildId) $result = Invoke-VstsEndpoint ` -Session $Session ` -Project $Project ` -Path $path ` -ApiVersion '2.0' return $result.Value } <# .SYNOPSIS Gets build queues for the collection. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Id The Id of the Build Queue to retrieve. .PARAMETER Name The Name of the Build Queue to retrieve. #> function Get-VstsBuildQueue { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter()] [Int32] $Id, [Parameter()] [String] $Name ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } $Path = 'build/queues' $additionalInvokeParameters = @{} if ($PSBoundParameters.ContainsKey('Id')) { $Path = ('{0}/{1}' -f $Path, $Id) } else { $additionalInvokeParameters = @{ QueryStringParameters = Get-VstsQueryStringParametersFromBound ` -BoundParameters $PSBoundParameters ` -ParameterList 'name' } } $Result = Invoke-VstsEndpoint ` -Session $Session ` -Path $Path ` -ApiVersion '2.0' ` @additionalInvokeParameters return $Result.Value } <# .SYNOPSIS Get a list of all tags across all builds or gets a list of tags for a specific build. .DESCRIPTION This cmdlet will return a list of tags used across all builds or will return a list of tags used in a specific build if the BuildId is passed. .PARAMETER AccountName The name of the VSTS account to use. .PARAMETER User This user name to authenticate to VSTS. .PARAMETER Token This personal access token to use to authenticate to VSTS. .PARAMETER Session The session object created by New-VstsSession. .PARAMETER Project The name of the project to create the new release in. .PARAMETER BuildId The id of the Build to return tags for. .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' Get-VstsBuildTag ` -Session $vstsSession ` -Project 'FabrikamFiber' Return all build tags in the project FabrikamFiber. .EXAMPLE > $vstsSession = New-VSTSSession ` -AccountName 'myvstsaccount' ` -User 'joe.bloggs@fabrikam.com' ` -Token 'hi3pxk5usaag6jslczs5bqmlkngvhr3czqyh65jdvlvtt3qkh4ya' Get-VstsBuildTag ` -Session $vstsSession ` -Project 'FabrikamFiber' ` -BuildId 103 Return all build tags for the build 103 in project FabrikamFiber. #> function Get-VstsBuildTag { [CmdletBinding(DefaultParameterSetName = 'Account')] param ( [Parameter(Mandatory = $True, ParameterSetName = 'Account')] [String] $AccountName, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $User, [Parameter(Mandatory = $true, ParameterSetName = 'Account')] [String] $Token, [Parameter(Mandatory = $True, ParameterSetName = 'Session')] $Session, [Parameter(Mandatory = $True)] [String] $Project, [Parameter()] [Int32] $BuildId ) if ($PSCmdlet.ParameterSetName -eq 'Account') { $Session = New-VstsSession -AccountName $AccountName -User $User -Token $Token } if ($PSBoundParameters.ContainsKey('BuildId')) { $path = 'build/builds/{0}/tags' -f $BuildId $additionalInvokeParameters = @{} } else { $path = 'build/tags' } $result = Invoke-VstsEndpoint ` -Session $Session ` -Path $path ` -Project $Project ` -ApiVersion '2.0' ` @additionalInvokeParameters return $result.Value } |