Public/ReleaseNotes/CollectData/Get-ReleaseNotesDataFromTimePeriod.ps1
|
function Get-ReleaseNotesDataFromTimePeriod { <# .SYNOPSIS Gets release notes data from Git based project. .PARAMETER CollectionUri Url for project collection on Azure DevOps server instance. Can be ommitted if $CollectionUri was previously accessed via this API. If not specified, $global:AzureDevOpsApi_CollectionUri (set by Set-AzureDevopsVariables) is used. .PARAMETER Project Project name, identifier, full project URI, or object with any one these properties. Can be ommitted if $Project was previously accessed via this API (will be extracted from the $ArtifactUri). If not specified, $global:AzureDevOpsApi_Project (set by Set-AzureDevopsVariables) is used. .PARAMETER DateFrom Starting date for the considered PullRequests. .PARAMETER DateTo Ending date for the considered PullRequests. .PARAMETER AsOf Gets the Work Items as they were at this date and time. .PARAMETER ByUser User(s) whose PullRequests will be used. #> [CmdletBinding()] param( [AllowNull()] [AllowEmptyString()] $CollectionUri, [AllowNull()] [AllowEmptyString()] $Project, [Alias('FromDate', 'From')] [Nullable[DateTime]] $DateFrom, [Alias('ToDate', 'To')] [Nullable[DateTime]] $DateTo, [Nullable[DateTime]] $AsOf, $ByUser ) # Correct paramater values $DateFrom = Use-FromDateTime -Value $DateFrom $DateTo = Use-ToDateTime -Value $DateTo $AsOf = Use-AsOfDateTime -Value $AsOf -DateTo $DateTo # Gather the release notes data from Pull Requests $data = @{ } # Get Work Item Id's from Time Period Show-Host -ForegroundColor Magenta -Object 'Gathering Time Period Work Items...' $workItemRefs = @( Get-WorkItemRefsListByTimePeriod ` -CollectionUri $CollectionUri ` -Project $Project ` -DateFrom $DateFrom ` -DateTo $DateTo ` -AsOf $AsOf ` -DateAttribute 'Microsoft.VSTS.Common.StateChangeDate' ) # Gather the release notes data from Time Period Show-Host -ForegroundColor Magenta -Object 'Gathering Work Item Data from Time Period...' $null = Add-WorkItemToReleaseNotesData ` -CollectionUri $CollectionUri ` -Project $Project ` -ReleaseNotesData $data ` -Reason 'TimePeriod' ` -AsOf $AsOf ` -WorkItem $workItemRefs ` -Recursive $false return $data } |