diff --git a/README.md b/README.md
index 3cfdb61..cfe20b2 100644
--- a/README.md
+++ b/README.md
@@ -117,7 +117,7 @@ Generation of release notes is presently *limited* to the module's [valid tags p
**Note:** Ensure your main project's CI file(s) and/or settings are configured to run CI jobs for tag refs.
-To create releases, reference the appropriate `release.yml` entrypoint CI template provided by this project from your CI file. The **release** step can also be customized through provided [parameters](docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml#L4-#L20).
+To create releases, reference the appropriate `release.yml` entrypoint CI template provided by this project from your CI file. The **release** step can also be customized through provided [parameters](docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml#L4-#L21).
Releases supports all tag refs. Tags *need not* follow [Semantic Versioning](https://semver.org/) though the convention is recommended.
@@ -127,30 +127,30 @@ Releases supports all tag refs. Tags *need not* follow [Semantic Versioning](htt
###### Generate and Release
-| Name | Value | Mandatory | Type |
+| Name | Example value | Mandatory | Type |
|:-:|:-:|:-:|:-:|
-| `PROJECT_DIRECTORY` | `/path/to/repository` | true | string |
-| `RELEASE_TAG_REF` | `vx.x.x` | true | string |
+| `PROJECT_DIRECTORY` | `/path/to/my-project` | true | string |
+| `RELEASE_TAG_REF` | `vx.x.x` / `branch` / `HEAD` / `remote/branch` / commit-hash | true | string |
###### Generate
-| Name | Value | Mandatory | Type |
+| Name | Example value | Mandatory | Type |
|:-:|:-:|:-:|:-:|
-| `RELEASE_NOTES_VARIANT` | `VersionDate-HashSubject-NoMerges` | false | string |
-| `RELEASE_NOTES_PATH` | `/path/to/repository/.release-notes.md` (full)
`.release-notes.md` (relative) | false | string |
+| `RELEASE_NOTES_VARIANT` | `VersionDate-HashSubject-NoMerges` ([List of available variants](src/PSRepositoryReleaseManager/generate/variants)) | false | string |
+| `RELEASE_NOTES_PATH` | `/path/to/.release-notes.md` (full) /
`.release-notes.md` (relative) | false | string |
###### Release
-| Name |
Value | Mandatory | Type |
-|:-:|:-|:-:|:-:|
-| `RELEASE_NAMESPACE` | `mygithubnamespace` | true | string |
-| `RELEASE_REPOSITORY` | `my-project` | true | string |
-| `GITHUB_API_TOKEN` | `xxx` | true | string |
-| `RELEASE_NAME` | `My release name` | false | string |
-| `RELEASE_NOTES_CONTENT` | My
multi-line
release
notes
| false | string |
-| `RELEASE_DRAFT` | `true` / `false` | false | string |
-| `RELEASE_PRERELEASE` | `true` / `false` | false | string |
-| `RELEASE_ASSETS` | path/to/asset1.tar.gz
path/to/asset2.gz
path/to/asset3.zip
path/to/assets/*.gz
path/to/assets/*.zip
| false | string |
+| Name | Example value | Mandatory | Type |
+|:-:|-|:-:|:-:|
+| `RELEASE_NAMESPACE` | `mygithubnamespace` | true | string |
+| `RELEASE_REPOSITORY` | `my-project` | true | string |
+| `GITHUB_API_TOKEN` | `xxx` | true | string |
+| `RELEASE_NAME` | `My release name` | false | string |
+| `RELEASE_NOTES_CONTENT` | `My`
`multi-line`
`release`
`notes` | false | string ([multiline](https://en.wikipedia.org/wiki/Here_document)) |
+| `RELEASE_DRAFT` | `true` / `false` | false | string |
+| `RELEASE_PRERELEASE` | `true` / `false` | false | string |
+| `RELEASE_ASSETS` | `path/to/asset1.tar.gz`
`path/to/asset2.gz`
`path/to/asset3.zip`
`path/to/assets/*.gz`
`path/to/assets/*.zip` | false | string ([multiline](https://en.wikipedia.org/wiki/Here_document)) |
##### Commands
diff --git a/docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml b/docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml
index 978964f..a785bec 100644
--- a/docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml
+++ b/docs/samples/ci/azure-pipelines/custom/azure-pipelines.release.yml
@@ -4,9 +4,10 @@ steps:
- template: templates/azure-pipelines/entrypoint/release.yml@PSRepositoryReleaseManager
# parameters:
# NAME: My release name
- # NOTES_PATH: path/to/my-release-notes.md
+ # NOTES_PATH: /path/to/.release-notes.md
# # NOTES_CONTENT: |
# # My
+ # #
# # multi-line
# # release
# # notes
diff --git a/src/scripts/ci/Invoke-Generate.ps1 b/src/scripts/ci/Invoke-Generate.ps1
index aa53607..8af7e99 100644
--- a/src/scripts/ci/Invoke-Generate.ps1
+++ b/src/scripts/ci/Invoke-Generate.ps1
@@ -8,28 +8,28 @@ $env:RELEASE_TAG_REF = 'v1.0.12'
./Invoke-Generate.ps1
# Default release notes variant and release notes path
-$env:PROJECT_DIRECTORY = '/path/to/repository'
+$env:PROJECT_DIRECTORY = '/path/to/my-project'
$env:RELEASE_TAG_REF = 'v1.0.12'
./Invoke-Generate.ps1
# Default release notes path
-$env:PROJECT_DIRECTORY = '/path/to/repository'
+$env:PROJECT_DIRECTORY = '/path/to/my-project'
$env:RELEASE_TAG_REF = 'v1.0.12'
$env:RELEASE_NOTES_VARIANT = 'Changes-HashSubject-NoMerges'
./Invoke-Generate.ps1
# Custom -ReleaseNotesPath relative to -ProjectDirectory
-$env:PROJECT_DIRECTORY = '/path/to/repository'
+$env:PROJECT_DIRECTORY = '/path/to/my-project'
$env:RELEASE_TAG_REF = 'v1.0.12'
$env:RELEASE_NOTES_VARIANT = 'Changes-HashSubject-NoMerges'
-$env:RELEASE_NOTES_PATH = 'my-custom-release-notes.md'
+$env:RELEASE_NOTES_PATH = '.release-notes.md'
./Invoke-Generate.ps1
# No defaults
-$env:PROJECT_DIRECTORY = '/path/to/repository'
+$env:PROJECT_DIRECTORY = '/path/to/my-project'
$env:RELEASE_TAG_REF = 'v1.0.12'
$env:RELEASE_NOTES_VARIANT = 'Changes-HashSubject-NoMerges'
-$env:RELEASE_NOTES_PATH = '/path/to/repository/.release-notes.md'
+$env:RELEASE_NOTES_PATH = '/path/to/.release-notes.md'
./Invoke-Generate.ps1
#>