Merge pull request #329 from Azure/feature/changelogscript

New Script to add/update version in change log

eng/common/Update-Change-Log.ps1

@@ -0,0 +1,123 @@
+# Note: This script will add or replace version title in change log
+
+# Parameter description
+# Version : Version to add or replace in change log
+# ChangeLogPath: Path to change log file. If change log path is set to directory then script will probe for change log file in that path 
+# Unreleased: Default is true. If it is set to false, then today's date will be set in verion title. If it is True then title will show "Unreleased"
+# ReplaceVersion: This is useful when replacing current version title with new title.( Helpful to update the title before package release)
+
+param (
+  [Parameter(Mandatory = $true)]
+  [String]$Version,
+  [Parameter(Mandatory = $true)]
+  [String]$ChangeLogPath,
+  [String]$Unreleased = $True,
+  [String]$ReplaceVersion = $False
+)
+
+
+$RELEASE_TITLE_REGEX = "(?<releaseNoteTitle>^\#+.*(?<version>\b\d+\.\d+\.\d+([^0-9\s][^\s:]+)?))"
+
+function Version-Matches($line)
+{
+    return ($line -match $RELEASE_TITLE_REGEX)
+}
+
+function Get-ChangelogPath($Path)
+{ 
+   # Check if CHANGELOG.md is present in path 
+   $ChangeLogPath = Join-Path -Path $Path -ChildPath "CHANGELOG.md"
+   if ((Test-Path -Path $ChangeLogPath) -eq $False){
+      # Check if change log exists with name HISTORY.md
+      $ChangeLogPath = Join-Path -Path $Path -ChildPath "HISTORY.md"
+      if ((Test-Path -Path $ChangeLogPath) -eq $False){
+         Write-Host "Change log is not found in path[$Path]"
+         exit(1)
+      }
+   }
+
+   Write-Host "Change log is found at path [$ChangeLogPath]"
+   return $ChangeLogPath
+}
+
+
+function Get-VersionTitle($Version, $Unreleased)
+{
+   # Generate version title
+   $newVersionTitle = "## $Version (Unreleased)"
+   if ($Unreleased -eq $False){
+      $releaseDate = Get-Date -Format "(yyyy-MM-dd)"
+      $newVersionTitle = "## $Version $releaseDate"
+   }
+   return $newVersionTitle
+}
+
+
+function Get-NewChangeLog( [System.Collections.ArrayList]$ChangelogLines, $Version, $Unreleased, $ReplaceVersion)
+{
+
+   # version parameter is to pass new version to add or replace
+   # Unreleased parameter can be set to False to set today's date instead of "Unreleased in title"
+   # ReplaceVersion param can be set to true to replace current version title( useful at release time to change title)
+
+   # find index of current version
+   $Index = 0
+   $CurrentTitle = ""
+   for(; $Index -lt $ChangelogLines.Count; $Index++){
+      if (Version-Matches($ChangelogLines[$Index])){
+         $CurrentTitle = $ChangelogLines[$Index]
+         Write-Host "Current Version title: $CurrentTitle"
+         break
+      }
+   }
+
+   # Generate version title
+   $newVersionTitle = Get-VersionTitle -Version $Version -Unreleased $Unreleased
+
+   if( $newVersionTitle -eq $CurrentTitle){
+      Write-Host "Version is already present in change log"
+      exit(0)
+   }
+
+   # if current version title already has new version then we should replace title to update it
+   if ($CurrentTitle.Contains($Version) -and $ReplaceVersion -eq $False){
+      Write-Host "Version is already present in title. Updating version title"
+      $ReplaceVersion = $True
+   }
+
+   # if version is already found and not replacing then nothing to do
+   if ($ReplaceVersion -eq $False){
+      Write-Host "Adding version title $newVersionTitle"
+      $ChangelogLines.insert($Index, "")
+      $ChangelogLines.insert($Index, "")
+      $ChangelogLines.insert($Index, $newVersionTitle)
+   }
+   else{
+      # Script is executed to replace an existing version title
+      Write-Host "Replacing current version title to $newVersionTitle"
+      $ChangelogLines[$index] = $newVersionTitle
+   }
+
+   return $ChangelogLines      
+}
+
+
+# Make sure path is valid
+if ((Test-Path -Path $ChangeLogPath) -eq $False){
+   Write-Host "Change log path is invalid. [$ChangeLogPath]"
+   exit(1)
+}
+
+# probe change log path if path is directory 
+if (Test-Path -Path $ChangeLogPath -PathType Container)
+{   
+   $ChangeLogPath = Get-ChangelogPath -Path $ChangeLogPath
+}
+
+# Read current change logs and add/update version
+$ChangelogLines = [System.Collections.ArrayList](Get-Content -Path $ChangeLogPath)
+$NewContents = Get-NewChangeLog -ChangelogLines $ChangelogLines -Version $Version -Unreleased $Unreleased -ReplaceVersion $ReplaceVersion
+
+Write-Host "Writing change log to file [$ChangeLogPath]"
+Set-Content -Path $ChangeLogPath $NewContents
+Write-Host "Version is added/updated in change log"