Merge pull request #70 from theohbrothers/enhancement/generate-set-de…

…fault-variant-to-versiondate-hashsubjectauthor-nomerges-categorized Enhancement (generate): Set default variant to `VersionDate-HashSubjectAuthor-NoMerges-Categorized`
theohbrothers · May 20, 2024 · 41e70a8 · 41e70a8
2 parents 264cf4f + 364d557
commit 41e70a8
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -36,7 +36,7 @@
                 "VersionDate-Subject-NoMerges",
                 "VersionDate-Subject",
               ],
-            "default": "VersionDate-HashSubject-NoMerges",
+            "default": "VersionDate-HashSubjectAuthor-NoMerges-Categorized",
         },
         {
             "id": "RELEASE_NOTES_PATH",

diff --git a/README.md b/README.md
@@ -136,7 +136,7 @@ Releases supports all tag refs. Tags *need not* follow [Semantic Versioning](htt
 
 | Name | Example value | Mandatory | Type |
 |:-:|:-:|:-:|:-:|
-| `RELEASE_NOTES_VARIANT` | `VersionDate-HashSubject-NoMerges` ([List of available variants](src/PSRepositoryReleaseManager/generate/variants)) | false | string |
+| `RELEASE_NOTES_VARIANT` | `VersionDate-HashSubjectAuthor-NoMerges-Categorized` ([List of available variants](src/PSRepositoryReleaseManager/generate/variants)) | false | string |
 | `RELEASE_NOTES_PATH` | `/path/to/.release-notes.md` (full) /<br>`.release-notes.md` (relative) | false | string |
 
 ###### Release

diff --git a/docs/samples/ci/azure-pipelines/custom/azure-pipelines.generate.yml b/docs/samples/ci/azure-pipelines/custom/azure-pipelines.generate.yml
@@ -3,5 +3,5 @@ steps:
   submodules: recursive
 - template: templates/azure-pipelines/entrypoint/generate.yml@PSRepositoryReleaseManager
   # parameters:
-  #   RELEASE_NOTES_VARIANT: VersionDate-HashSubject-NoMerges
+  #   RELEASE_NOTES_VARIANT: VersionDate-HashSubjectAuthor-NoMerges-Categorized
   #   RELEASE_NOTES_PATH: .release-notes.md
diff --git a/src/scripts/ci/Invoke-Generate.ps1 b/src/scripts/ci/Invoke-Generate.ps1
@@ -66,7 +66,7 @@ try {
                       "`$env:RELEASE_TAG_REF is null or undefined. Using the default ref 'HEAD'" | Write-Verbose
                       'HEAD'
                   }
-        Variant = if ($env:RELEASE_NOTES_VARIANT) { $env:RELEASE_NOTES_VARIANT } else { 'VersionDate-HashSubject-NoMerges' }
+        Variant = if ($env:RELEASE_NOTES_VARIANT) { $env:RELEASE_NOTES_VARIANT } else { 'VersionDate-HashSubjectAuthor-NoMerges-Categorized' }
         ReleaseNotesPath = if ($env:RELEASE_NOTES_PATH) {
                                "Using specified release notes path '$env:RELEASE_NOTES_PATH'" | Write-Verbose
                                if ([System.IO.Path]::IsPathRooted($env:RELEASE_NOTES_PATH)) { $env:RELEASE_NOTES_PATH }