Add prompt before replasing latest release title on prepare release run (Azure#18522)

azure-sdk · chidozieononiwu · web-flow · commit be431bcc1a60 · 2021-11-03T19:28:00.000-07:00
Co-authored-by: Chidozie Ononiwu &lt;chononiw@microsoft.com&gt;
diff --git a/eng/common/scripts/ChangeLog-Operations.ps1 b/eng/common/scripts/ChangeLog-Operations.ps1
@@ -351,4 +351,15 @@ function Remove-EmptySections {
     }
     $ChangeLogEntry.ReleaseContent = $sanitizedReleaseContent.ToArray()
   }
+}
+
+function  Get-LatestReleaseDateFromChangeLog
+{
+  param (
+    [Parameter(Mandatory = $true)]
+    $ChangeLogLocation
+  )
+  $changeLogEntries = Get-ChangeLogEntries -ChangeLogLocation $ChangeLogLocation
+  $latestVersion = $changeLogEntries[0].ReleaseStatus.Trim("()")
+  return ($latestVersion -as [DateTime])
 }
diff --git a/eng/common/scripts/Prepare-Release.ps1 b/eng/common/scripts/Prepare-Release.ps1
@@ -177,8 +177,17 @@ if ($releaseTrackingOnly)
 
 if (Test-Path "Function:SetPackageVersion")
 {
-  SetPackageVersion -PackageName $packageProperties.Name -Version $newVersion -ServiceDirectory $packageProperties.ServiceDirectory -ReleaseDate $releaseDateString `
-    -PackageProperties $packageProperties
+  $replaceLatestEntryTitle = $true
+  $latestVersion = Get-LatestReleaseDateFromChangeLog -ChangeLogLocation $packageProperties.ChangeLogPath
+  if ($latestVersion)
+  {
+    $promptMessage = "The latest entry in the CHANGELOG.md already has a release date. Do you want to replace the latest entry title? Please enter (y or n)."
+    while (($readInput = Read-Host -Prompt $promptMessage) -notmatch '^[yn]$'){ }
+    $replaceLatestEntryTitle = ($readInput -eq "y")
+  }
+  SetPackageVersion -PackageName $packageProperties.Name -Version $newVersion `
+    -ServiceDirectory $packageProperties.ServiceDirectory -ReleaseDate $releaseDateString `
+    -PackageProperties $packageProperties -ReplaceLatestEntryTitle $replaceLatestEntryTitle
 }
 else
 {

Original file line number	Diff line number	Diff line change
`@@ -351,4 +351,15 @@ function Remove-EmptySections {`
`351`	`351`	`}`
`352`	`352`	`$ChangeLogEntry.ReleaseContent = $sanitizedReleaseContent.ToArray()`
`353`	`353`	`}`
	`354`	`+}`
	`355`	`+`
	`356`	`+function Get-LatestReleaseDateFromChangeLog`
	`357`	`+{`
	`358`	`+ param (`
	`359`	`+ [Parameter(Mandatory = $true)]`
	`360`	`+ $ChangeLogLocation`
	`361`	`+ )`
	`362`	`+ $changeLogEntries = Get-ChangeLogEntries -ChangeLogLocation $ChangeLogLocation`
	`363`	`+ $latestVersion = $changeLogEntries[0].ReleaseStatus.Trim("()")`
	`364`	`+ return ($latestVersion -as [DateTime])`
`354`	`365`	`}`
Original file line number	Diff line number	Diff line change
`@@ -177,8 +177,17 @@ if ($releaseTrackingOnly)`
`177`	`177`
`178`	`178`	`if (Test-Path "Function:SetPackageVersion")`
`179`	`179`	`{`
`180`		- SetPackageVersion -PackageName $packageProperties.Name -Version $newVersion -ServiceDirectory $packageProperties.ServiceDirectory -ReleaseDate $releaseDateString `
`181`		`- -PackageProperties $packageProperties`
	`180`	`+ $replaceLatestEntryTitle = $true`
	`181`	`+ $latestVersion = Get-LatestReleaseDateFromChangeLog -ChangeLogLocation $packageProperties.ChangeLogPath`
	`182`	`+ if ($latestVersion)`
	`183`	`+ {`
	`184`	`+ $promptMessage = "The latest entry in the CHANGELOG.md already has a release date. Do you want to replace the latest entry title? Please enter (y or n)."`
	`185`	`+ while (($readInput = Read-Host -Prompt $promptMessage) -notmatch '^[yn]$'){ }`
	`186`	`+ $replaceLatestEntryTitle = ($readInput -eq "y")`
	`187`	`+ }`
	`188`	+ SetPackageVersion -PackageName $packageProperties.Name -Version $newVersion `
	`189`	+ -ServiceDirectory $packageProperties.ServiceDirectory -ReleaseDate $releaseDateString `
	`190`	`+ -PackageProperties $packageProperties -ReplaceLatestEntryTitle $replaceLatestEntryTitle`
`182`	`191`	`}`
`183`	`192`	`else`
`184`	`193`	`{`