Merge pull request #172 from theohbrothers/refactor/generate-standard…

…ize-ref-parameter-for-generate-functions Refactor (generate): Standardize ref parameter for generate functions
theohbrothers · Jul 28, 2024 · 2201886 · 2201886
2 parents afe4fbd + c94bec0
commit 2201886
Show file tree

Hide file tree

Showing 23 changed files with 80 additions and 80 deletions.
diff --git a/src/PSRepositoryReleaseManager/Public/Generate-ReleaseNotes.ps1 b/src/PSRepositoryReleaseManager/Public/Generate-ReleaseNotes.ps1
@@ -8,7 +8,7 @@ function Generate-ReleaseNotes {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
         ,
         [Parameter(Mandatory=$true)]
         [ValidateSet(
@@ -44,7 +44,7 @@ function Generate-ReleaseNotes {
     try {
         $private:generateArgs = @{
             Path = $Path
-            TagName = $TagName
+            Ref = $Ref
         }
         "Generating release notes of variant '$($Variant)'" | Write-Verbose
         $releaseNotesContent = & $Variant @private:generateArgs -ErrorAction Stop

diff --git a/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-Merges.ps1 b/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-Merges.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubject-Merges {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             Merges = $true
         }

diff --git a/...PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges-Categorized.ps1 b/...PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges-Categorized.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubject-NoMerges-Categorized {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }

diff --git a/...sitoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges-CategorizedSorted.ps1 b/...sitoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges-CategorizedSorted.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubject-NoMerges-CategorizedSorted {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }

diff --git a/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges.ps1 b/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject-NoMerges.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubject-NoMerges {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }

diff --git a/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject.ps1 b/src/PSRepositoryReleaseManager/generate/variants/Changes-HashSubject.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubject {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
         }
         if ($previousRelease) { $funcArgs['SecondRef'] = @($previousRelease)[0] }

diff --git a/...sitoryReleaseManager/generate/variants/Changes-HashSubjectAuthor-NoMerges-Categorized.ps1 b/...sitoryReleaseManager/generate/variants/Changes-HashSubjectAuthor-NoMerges-Categorized.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubjectAuthor-NoMerges-Categorized {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s - `%aN`'
             NoMerges = $true
         }

diff --git a/...ReleaseManager/generate/variants/Changes-HashSubjectAuthor-NoMerges-CategorizedSorted.ps1 b/...ReleaseManager/generate/variants/Changes-HashSubjectAuthor-NoMerges-CategorizedSorted.ps1
@@ -7,16 +7,16 @@ function Changes-HashSubjectAuthor-NoMerges-CategorizedSorted {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s - `%aN`'
             NoMerges = $true
         }

diff --git a/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject-Merges.ps1 b/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject-Merges.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubject-Merges {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             Merges = $true
         }
@@ -25,7 +25,7 @@ function VersionDate-HashSubject-Merges {
         $commitHistoryCollection = $commitHistory -split "`n" | % { $_.Trim() } | ? { $_ }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 
 "@
             $commitHistoryCollection | % {

diff --git a/...positoryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges-Categorized.ps1 b/...positoryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges-Categorized.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubject-NoMerges-Categorized {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }
@@ -120,7 +120,7 @@ function VersionDate-HashSubject-NoMerges-Categorized {
         }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 "@
             foreach ($c in $commitHistoryCategory) {
                 $iscommitHistoryCategoryTitleOutputted = $false

diff --git a/...ryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges-CategorizedSorted.ps1 b/...ryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges-CategorizedSorted.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubject-NoMerges-CategorizedSorted {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }
@@ -138,7 +138,7 @@ function VersionDate-HashSubject-NoMerges-CategorizedSorted {
         }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 "@
             foreach ($c in $commitHistoryCategory) {
                 $iscommitHistoryCategoryTitleOutputted = $false

diff --git a/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges.ps1 b/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject-NoMerges.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubject-NoMerges {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
             NoMerges = $true
         }
@@ -25,7 +25,7 @@ function VersionDate-HashSubject-NoMerges {
         $commitHistoryCollection = $commitHistory -split "`n" | % { $_.Trim() } | ? { $_ }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 
 "@
             $commitHistoryCollection | % {

diff --git a/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject.ps1 b/src/PSRepositoryReleaseManager/generate/variants/VersionDate-HashSubject.ps1
@@ -7,24 +7,24 @@ function VersionDate-HashSubject {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s'
         }
         if ($previousRelease) { $funcArgs['SecondRef'] = @($previousRelease)[0] }
         $commitHistory = Get-RepositoryCommitHistory @funcArgs
         $commitHistoryCollection = $commitHistory -split "`n" | % { $_.Trim() } | ? { $_ }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 
 "@
             $commitHistoryCollection | % {

diff --git a/...ryReleaseManager/generate/variants/VersionDate-HashSubjectAuthor-NoMerges-Categorized.ps1 b/...ryReleaseManager/generate/variants/VersionDate-HashSubjectAuthor-NoMerges-Categorized.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubjectAuthor-NoMerges-Categorized {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s - `%aN`'
             NoMerges = $true
         }
@@ -120,7 +120,7 @@ function VersionDate-HashSubjectAuthor-NoMerges-Categorized {
         }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 "@
             foreach ($c in $commitHistoryCategory) {
                 $iscommitHistoryCategoryTitleOutputted = $false

diff --git a/...aseManager/generate/variants/VersionDate-HashSubjectAuthor-NoMerges-CategorizedSorted.ps1 b/...aseManager/generate/variants/VersionDate-HashSubjectAuthor-NoMerges-CategorizedSorted.ps1
@@ -7,16 +7,16 @@ function VersionDate-HashSubjectAuthor-NoMerges-CategorizedSorted {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%h %s - `%aN`'
             NoMerges = $true
         }
@@ -140,7 +140,7 @@ function VersionDate-HashSubjectAuthor-NoMerges-CategorizedSorted {
         }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 "@
             foreach ($c in $commitHistoryCategory) {
                 $iscommitHistoryCategoryTitleOutputted = $false

diff --git a/src/PSRepositoryReleaseManager/generate/variants/VersionDate-Subject-Merges.ps1 b/src/PSRepositoryReleaseManager/generate/variants/VersionDate-Subject-Merges.ps1
@@ -7,16 +7,16 @@ function VersionDate-Subject-Merges {
         ,
         [Parameter(Mandatory=$true)]
         [ValidateNotNullOrEmpty()]
-        [string]$TagName
+        [string]$Ref
     )
 
     $ErrorActionPreference = 'Stop'
 
     try {
-        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $TagName -ErrorAction SilentlyContinue
+        $previousRelease = Get-RepositoryReleasePrevious -Path $Path -Ref $Ref -ErrorAction SilentlyContinue
         $funcArgs = @{
             Path = $Path
-            FirstRef = $TagName
+            FirstRef = $Ref
             PrettyFormat = '%s'
             Merges = $true
         }
@@ -25,7 +25,7 @@ function VersionDate-Subject-Merges {
         $commitHistoryCollection = $commitHistory -split "`n" | % { $_.Trim() } | ? { $_ }
         $releaseBody = & {
 @"
-## $TagName ($(Get-Date -UFormat '%Y-%m-%d'))
+## $Ref ($(Get-Date -UFormat '%Y-%m-%d'))
 
 "@
             $commitHistoryCollection | % {