From 94d358b7336896360c6cf705ebfec9459220a9da Mon Sep 17 00:00:00 2001
From: Wes Haggard <Wes.Haggard@microsoft.com>
Date: Thu, 1 Jul 2021 14:00:58 -0700
Subject: [PATCH] Update change log headers based on guideline update

Updates based on https://github.com/Azure/azure-sdk/pull/3103

- Renamed "Key Bugs Fixed" to "Bugs Fixed"
- Renamed "Fixed" to "Other Changes"

Added a warning in validation if at lease one of the recommended
headers aren't used.
---
 eng/common/scripts/ChangeLog-Operations.ps1 | 38 ++++++++++++---------
 1 file changed, 22 insertions(+), 16 deletions(-)

diff --git a/eng/common/scripts/ChangeLog-Operations.ps1 b/eng/common/scripts/ChangeLog-Operations.ps1
index 6a161c1b4df..44c7f6b24cb 100644
--- a/eng/common/scripts/ChangeLog-Operations.ps1
+++ b/eng/common/scripts/ChangeLog-Operations.ps1
@@ -5,6 +5,7 @@
 $RELEASE_TITLE_REGEX = "(?<releaseNoteTitle>^\#+\s+(?<version>$([AzureEngSemanticVersion]::SEMVER_REGEX))(\s+(?<releaseStatus>\(.+\))))"
 $CHANGELOG_UNRELEASED_STATUS = "(Unreleased)"
 $CHANGELOG_DATE_FORMAT = "yyyy-MM-dd"
+$RecommendedSectionHeaders = @("Features Added", "Breking Changes", "Bugs Fixed", "Other Changes")
 
 # Returns a Collection of changeLogEntry object containing changelog info for all version present in the gived CHANGELOG
 function Get-ChangeLogEntries {
@@ -109,7 +110,6 @@ function Get-ChangeLogEntryAsString {
   return ChangeLogEntryAsString $changeLogEntry
 }
 
-
 function ChangeLogEntryAsString($changeLogEntry) {
   if (!$changeLogEntry) {
     return "[Missing change log entry]"
@@ -141,13 +141,13 @@ function Confirm-ChangeLogEntry {
   Write-Host "-----"
 
   if ([System.String]::IsNullOrEmpty($changeLogEntry.ReleaseStatus)) {
-    LogError "Entry does not have a correct release status. Please ensure the status is set to a date '($CHANGELOG_DATE_FORMAT)' or '$CHANGELOG_UNRELEASED_STATUS' if not yet released."
+    LogError "Entry does not have a correct release status. Please ensure the status is set to a date '($CHANGELOG_DATE_FORMAT)' or '$CHANGELOG_UNRELEASED_STATUS' if not yet released. See https://aka.ms/azsdk/guideline/changelogs for more info."
     return $false
   }
 
   if ($ForRelease -eq $True) {
     if ($changeLogEntry.ReleaseStatus -eq $CHANGELOG_UNRELEASED_STATUS) {
-      LogError "Entry has no release date set. Please ensure to set a release date with format '$CHANGELOG_DATE_FORMAT'."
+      LogError "Entry has no release date set. Please ensure to set a release date with format '$CHANGELOG_DATE_FORMAT'. See https://aka.ms/azsdk/guideline/changelogs for more info."
       return $false
     }
     else {
@@ -156,26 +156,27 @@ function Confirm-ChangeLogEntry {
         $releaseDate = [DateTime]$status
         if ($status -ne ($releaseDate.ToString($CHANGELOG_DATE_FORMAT)))
         {
-          LogError "Date must be in the format $($CHANGELOG_DATE_FORMAT)"
+          LogError "Date must be in the format $($CHANGELOG_DATE_FORMAT). See https://aka.ms/azsdk/guideline/changelogs for more info."
           return $false
         }
         if (((Get-Date).AddMonths(-1) -gt $releaseDate) -or ($releaseDate -gt (Get-Date).AddMonths(1)))
         {
-          LogError "The date must be within +/- one month from today."
+          LogError "The date must be within +/- one month from today. See https://aka.ms/azsdk/guideline/changelogs for more info."
           return $false
         }
       }
       catch {
-          LogError "Invalid date [ $status ] passed as status for Version [$($changeLogEntry.ReleaseVersion)]."
+          LogError "Invalid date [ $status ] passed as status for Version [$($changeLogEntry.ReleaseVersion)]. See https://aka.ms/azsdk/guideline/changelogs for more info."
           return $false
       }
     }
 
     if ([System.String]::IsNullOrWhiteSpace($changeLogEntry.ReleaseContent)) {
-      LogError "Entry has no content. Please ensure to provide some content of what changed in this version."
+      LogError "Entry has no content. Please ensure to provide some content of what changed in this version. See https://aka.ms/azsdk/guideline/changelogs for more info."
       return $false
     }
 
+    $foundRecomendedSection = $false
     $emptySections = @()
     foreach ($key in $changeLogEntry.Sections.Keys)
     {
@@ -184,12 +185,20 @@ function Confirm-ChangeLogEntry {
       {
         $emptySections += $key
       }
+      if ($RecommendedSectionHeaders -contains $key)
+      {
+        $foundRecomendedSection = $true
+      }
     }
     if ($emptySections.Count -gt 0)
     {
       LogError "The changelog entry has the following sections with no content ($($emptySections -join ', ')). Please ensure to either remove the empty sections or add content to the section."
       return $false
     }
+    if (!$foundRecomendedSection)
+    {
+      LogWarning "The changelog entry did not contain any of the recommended sections ($($RecommendedSectionHeaders -join ', ')), pease add at least one. See https://aka.ms/azsdk/guideline/changelogs for more info."
+    }
   }
   return $true
 }
@@ -228,15 +237,12 @@ function New-ChangeLogEntry {
   if (!$Content) {
     $Content = @()
     $Content += ""
-    $Content += "### Features Added"
-    $Content += ""
-    $Content += "### Breaking Changes"
-    $Content += ""
-    $Content += "### Key Bugs Fixed"
-    $Content += ""
-    $Content += "### Fixed"
-    $Content += ""
-    $Content += ""
+
+    foreach ($recommendedHeader in $RecommendedSectionHeaders)
+    {
+      $Content += "### $recommendedHeader"
+      $Content += ""
+    }
   }
 
   $newChangeLogEntry = [pscustomobject]@{