Merge pull request #28 from theohbrothers/docs/generate-tweak-documen…

…tation-on-generating-release-notes-in-development Docs (generate): Tweak documentation on generating release notes
theohbrothers · May 4, 2024 · e26201e · e26201e
2 parents 0e63265 + 4c9045e
commit e26201e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ Add a secret variable `GITHUB_API_TOKEN` containing your [GitHub API token](http
 
 #### Generating release notes
 
-The entrypoint script [`Invoke-Generate.ps1`](src/scripts/ci/Invoke-Generate.ps1) is used to generate release notes based off local repositories. To generate one, specify the path to the local repository and the variant of release notes to generate.
+The entrypoint script [`Invoke-Generate.ps1`](src/scripts/ci/Invoke-Generate.ps1) is used to generate release notes based off local repositories. To generate one, specify the path to the local repository, the release tag ref, the release notes variant, and the release notes path.
 
 ##### Variants
 

diff --git a/src/scripts/ci/Invoke-Generate.ps1 b/src/scripts/ci/Invoke-Generate.ps1
@@ -15,7 +15,9 @@ param(
     [Parameter(Mandatory=$false)]
     [ValidateNotNullOrEmpty()]
     [string]$ReleaseNotesPath
-    <#
+
+    <# Examples
+
     # Maximum defaults
     ./Invoke-Generate.ps1 -ReleaseTagRef v1.0.12
 
@@ -31,6 +33,7 @@ param(
     # No defaults
     ./Invoke-Generate.ps1 -ProjectDirectory '/path/to/repository' -ReleaseTagRef v1.0.12 -ReleaseNotesVariant 'Changes-HashSubject-NoMerges' -ReleaseNotesPath '/path/to/repository/.release-notes.md'
     #>
+
 )
 
 $ErrorActionPreference = 'Stop'