125 lines
4.1 KiB
PowerShell
125 lines
4.1 KiB
PowerShell
$RELEASE_TITLE_REGEX = "(?<releaseNoteTitle>^\#+.*(?<version>\b\d+\.\d+\.\d+([^0-9\s][^\s:]+)?)(\s(?<releaseStatus>\(Unreleased\)|\(\d{4}-\d{2}-\d{2}\)))?)"
|
|
|
|
# Returns a Collection of changeLogEntry object containing changelog info for all version present in the gived CHANGELOG
|
|
function Get-ChangeLogEntries {
|
|
param (
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$ChangeLogLocation
|
|
)
|
|
|
|
$changeLogEntries = @{}
|
|
if (!(Test-Path $ChangeLogLocation)) {
|
|
Write-Error "ChangeLog[${ChangeLogLocation}] does not exist"
|
|
return $null
|
|
}
|
|
|
|
try {
|
|
$contents = Get-Content $ChangeLogLocation
|
|
# walk the document, finding where the version specifiers are and creating lists
|
|
$changeLogEntry = $null
|
|
foreach ($line in $contents) {
|
|
if ($line -match $RELEASE_TITLE_REGEX) {
|
|
$changeLogEntry = [pscustomobject]@{
|
|
ReleaseVersion = $matches["version"]
|
|
ReleaseStatus = $matches["releaseStatus"]
|
|
ReleaseTitle = $line
|
|
ReleaseContent = @() # Release content without the version title
|
|
}
|
|
$changeLogEntries[$changeLogEntry.ReleaseVersion] = $changeLogEntry
|
|
}
|
|
else {
|
|
if ($changeLogEntry) {
|
|
$changeLogEntry.ReleaseContent += $line
|
|
}
|
|
}
|
|
}
|
|
}
|
|
catch {
|
|
Write-Host "Error parsing $ChangeLogLocation."
|
|
Write-Host $_.Exception.Message
|
|
}
|
|
return $changeLogEntries
|
|
}
|
|
|
|
# Returns single changeLogEntry object containing the ChangeLog for a particular version
|
|
function Get-ChangeLogEntry {
|
|
param (
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$ChangeLogLocation,
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$VersionString
|
|
)
|
|
$changeLogEntries = Get-ChangeLogEntries -ChangeLogLocation $ChangeLogLocation
|
|
|
|
if ($changeLogEntries -and $changeLogEntries.ContainsKey($VersionString)) {
|
|
return $changeLogEntries[$VersionString]
|
|
}
|
|
return $null
|
|
}
|
|
|
|
#Returns the changelog for a particular version as string
|
|
function Get-ChangeLogEntryAsString {
|
|
param (
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$ChangeLogLocation,
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$VersionString
|
|
)
|
|
|
|
$changeLogEntry = Get-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString
|
|
return ChangeLogEntryAsString $changeLogEntry
|
|
}
|
|
|
|
function ChangeLogEntryAsString($changeLogEntry) {
|
|
if (!$changeLogEntry) {
|
|
return "[Missing change log entry]"
|
|
}
|
|
[string]$releaseTitle = $changeLogEntry.ReleaseTitle
|
|
[string]$releaseContent = $changeLogEntry.ReleaseContent -Join [Environment]::NewLine
|
|
return $releaseTitle, $releaseContent -Join [Environment]::NewLine
|
|
}
|
|
|
|
function Confirm-ChangeLogEntry {
|
|
param (
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$ChangeLogLocation,
|
|
[Parameter(Mandatory = $true)]
|
|
[String]$VersionString,
|
|
[boolean]$ForRelease = $false
|
|
)
|
|
|
|
$changeLogEntry = Get-ChangeLogEntry -ChangeLogLocation $ChangeLogLocation -VersionString $VersionString
|
|
|
|
if (!$changeLogEntry) {
|
|
Write-Error "ChangeLog[${ChangeLogLocation}] does not have an entry for version ${VersionString}."
|
|
return $false
|
|
}
|
|
|
|
Write-Host "Found the following change log entry for version '${VersionString}' in [${ChangeLogLocation}]."
|
|
Write-Host "-----"
|
|
Write-Host (ChangeLogEntryAsString $changeLogEntry)
|
|
Write-Host "-----"
|
|
|
|
if ([System.String]::IsNullOrEmpty($changeLogEntry.ReleaseStatus)) {
|
|
Write-Error "Entry does not have a correct release status. Please ensure the status is set to a date '(yyyy-MM-dd)' or '(Unreleased)' if not yet released."
|
|
return $false
|
|
}
|
|
|
|
if ($ForRelease -eq $True) {
|
|
if ($changeLogEntry.ReleaseStatus -eq "(Unreleased)") {
|
|
Write-Error "Entry has no release date set. Please ensure to set a release date with format 'yyyy-MM-dd'."
|
|
return $false
|
|
}
|
|
|
|
if ([System.String]::IsNullOrWhiteSpace($changeLogEntry.ReleaseContent)) {
|
|
Write-Error "Entry has no content. Please ensure to provide some content of what changed in this version."
|
|
return $false
|
|
}
|
|
}
|
|
return $true
|
|
}
|
|
|
|
Export-ModuleMember -Function 'Get-ChangeLogEntries'
|
|
Export-ModuleMember -Function 'Get-ChangeLogEntry'
|
|
Export-ModuleMember -Function 'Get-ChangeLogEntryAsString'
|
|
Export-ModuleMember -Function 'Confirm-ChangeLogEntry' |