Scripts/Block-OctopusRelease.ps1
|
<#
.Synopsis Blocks an Octopus Release from being deployed to another environment .DESCRIPTION Blocks an Octopus Release from being deployed to another environment .EXAMPLE Block-OctopusRelease -Projectname "MyProduct.WebApp" -Version 1.0.0 Blocks release 1.0.0 of the project "MyProduct.WebApp" .EXAMPLE Get-OctopusRelease -Project "MyProduct.Webapp" -version 1.0.1 | Block-OctopusRelease -Reason "Because of reasons" Blocks the release 1.0.1 of the project "MyProduct.Webapp" with a custom reason text .LINK Github project: https://github.com/Dalmirog/Octoposh Advanced Cmdlet Usage: https://github.com/Dalmirog/OctoPosh/wiki/Advanced-Examples QA and Cmdlet request: https://gitter.im/Dalmirog/OctoPosh#initial #> function Block-OctopusRelease { [CmdletBinding()] Param ( # Project name [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName = $true)] [string]$ProjectName, # Release version number [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName = $true)] [string]$ReleaseVersion, # Description for the blocking [ValidateNotNullOrEmpty()] [string]$Description, # Forces cmdlet to continue without prompting [switch]$Force ) Begin { $c = New-OctopusConnection If([string]::IsNullOrEmpty($Description)){ $Description = "Blocking release $ReleaseVersion of project $ProjectName from Octoposh" } $body = @{Description = $Description} | ConvertTo-Json } Process { If(!($Force)){ If (!(Get-UserConfirmation -message "Are you sure you want to block release $ReleaseVersion on project $ProjectName ?")){ Throw "Canceled by user" } } Write-Verbose "[$($MyInvocation.MyCommand)] Looking for project: $ProjectName" $p = Get-OctopusProject -ProjectName $ProjectName -ErrorAction Stop -ResourceOnly Write-Verbose "[$($MyInvocation.MyCommand)] Project found: $ProjectName" Write-Verbose "[$($MyInvocation.MyCommand)] Looking for release: $ReleaseVersion" $release = $c.repository.Projects.GetReleaseByVersion($p, $ReleaseVersion) If($release -eq $null){ Throw "Release $ReleaseVersion not found for project $ProjectName" } Write-Verbose "[$($MyInvocation.MyCommand)] Release found: $($Release.version)" Try{ Write-Verbose "[$($MyInvocation.MyCommand)] Blocking release $($Release.version)" $r = Invoke-WebRequest $env:OctopusURL/$($release.links.ReportDefect) -Method Post -Headers $c.header -Body $body -UseBasicParsing -Verbose:$false } Catch{ write-error $_ } } End { Write-Verbose "[$($MyInvocation.MyCommand)] HTTP request to block release $($Release.version) of project $($p.name) returned code $($r.statuscode)" if($r.statuscode -eq 200){ Return $True } Else{ Return $false } } } |