From 33ab368c5ce160132ef995de773bbace9aa2c484 Mon Sep 17 00:00:00 2001 From: Sekers <46898253+Sekers@users.noreply.github.com> Date: Wed, 16 Sep 2026 16:02:47 -0500 Subject: [PATCH] Fix documentation errors in help, README, RELEASING, and CHANGELOG - Get-ScriptMessageConfig, Set-ScriptMessageConfigFilePath: the help's .PARAMETER entry named ConfigPath and Service instead of Path, so Get-Help showed no description for -Path. - Send-ScriptMessage help example 4: close the attachment array with ) instead of }, and end the example by calling Send-ScriptMessage. - README.md: remove the link to a Sample_Usage_Scripts folder that does not exist. - RELEASING.md: use a placeholder in the [Unreleased] compare link instead of a hard-coded 1.2.0. - CHANGELOG.md: point the 1.0.0 heading at this repository instead of SKYAPI, and add [Unreleased] with the help fixes. --- CHANGELOG.md | 10 +++++++++- README.md | 2 +- RELEASING.md | 5 +++-- ScriptMessage/Public/Get-ScriptMessageConfig.ps1 | 2 +- ScriptMessage/Public/Send-ScriptMessage.ps1 | 6 ++++-- .../Public/Set-ScriptMessageConfigFilePath.ps1 | 2 +- 6 files changed, 19 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 60882dd..f17c4c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog for ScriptMessage PowerShell Module +## [Unreleased](https://github.com/Sekers/ScriptMessage/compare/1.1.1...develop) + +### Fixed + +- Minor: The help for `Get-ScriptMessageConfig` and `Set-ScriptMessageConfigFilePath` now describes the `-Path` parameter, which it left blank. +- Minor: The fourth `Send-ScriptMessage` help example, which sends attachments held in variables, now runs as written. It failed with "Missing closing ')' in subexpression" when copied, and it ended without calling `Send-ScriptMessage`. + +--- ## [1.1.1](https://github.com/Sekers/ScriptMessage/tree/1.1.1) - 2026-09-16 ### Changed @@ -144,7 +152,7 @@ Author: [**@Sekers**](https://github.com/Sekers) Author: [**@Sekers**](https://github.com/Sekers) --- -## [1.0.0](https://github.com/Sekers/SKYAPI/tree/1.0.0) - (2024-05-20) +## [1.0.0](https://github.com/Sekers/ScriptMessage/tree/1.0.0) - (2024-05-20) ### Features diff --git a/README.md b/README.md index c1bab01..e06efbd 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ See [CHANGELOG.md](./CHANGELOG.md) for information on the latest updates, as wel ## Documentation -The ScriptMessage module documentation is hosted in the [ScriptMessage Wiki](https://github.com/Sekers/ScriptMessage/wiki). Examples are included in the [Sample Usage Scripts folder](./Sample_Usage_Scripts) as well as in the comment-based help for each function/cmdlet (e.g., Get-Help Connect-ScriptMessage). +The ScriptMessage module documentation is hosted in the [ScriptMessage Wiki](https://github.com/Sekers/ScriptMessage/wiki). Examples are included in the comment-based help for each function/cmdlet (e.g., Get-Help Connect-ScriptMessage -Examples). --- diff --git a/RELEASING.md b/RELEASING.md index 0c252a2..67c785d 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -108,8 +108,9 @@ user-visible change adds its entry under `## [Unreleased]`, in one of these sect `[Unreleased]` exists only on `develop`, and only while it has entries. A release renames it to the version heading, so right after a release there is none. The next pull request that adds an entry also adds the section at the top, linked to a comparison from the last release: -`## [Unreleased](https://github.com/Sekers/ScriptMessage/compare/1.2.0...develop)`. The Release workflow refuses to -publish a tag whose `CHANGELOG.md` still has an `[Unreleased]` section. +`## [Unreleased](https://github.com/Sekers/ScriptMessage/compare/...develop)`, where `` is the +latest release tag. The Release workflow refuses to publish a tag whose `CHANGELOG.md` still has an `[Unreleased]` +section. ## Releasing a version diff --git a/ScriptMessage/Public/Get-ScriptMessageConfig.ps1 b/ScriptMessage/Public/Get-ScriptMessageConfig.ps1 index 639b962..dc85ee2 100644 --- a/ScriptMessage/Public/Get-ScriptMessageConfig.ps1 +++ b/ScriptMessage/Public/Get-ScriptMessageConfig.ps1 @@ -10,7 +10,7 @@ function Get-ScriptMessageConfig .DESCRIPTION Get the configuration and secrets to connect to the messaging service(s). - .PARAMETER ConfigPath + .PARAMETER Path Optional. If not provided, the function will use the path used in the current session (if set). .PARAMETER Service Optional. Return only the info related to a specific service. diff --git a/ScriptMessage/Public/Send-ScriptMessage.ps1 b/ScriptMessage/Public/Send-ScriptMessage.ps1 index cd30b05..25ec3fc 100644 --- a/ScriptMessage/Public/Send-ScriptMessage.ps1 +++ b/ScriptMessage/Public/Send-ScriptMessage.ps1 @@ -117,7 +117,7 @@ function Send-ScriptMessage # $Content2 = Get-Content -AsByteStream -Raw -Path 'C:\Users\John\Downloads\AMovie.mp4' $Attachment = @( - @{ + @{ Name = 'MyPDF.pdf' Content = $Content1 }, @@ -125,7 +125,7 @@ function Send-ScriptMessage Name = 'funnyballgame.mp4' Content = $Content2 } - } + ) $MessageArguments = @{ From = @{ @@ -138,6 +138,8 @@ function Send-ScriptMessage } Attachment = $Attachment } + + Send-ScriptMessage -Service MicrosoftGraph @MessageArguments #> [CmdletBinding()] diff --git a/ScriptMessage/Public/Set-ScriptMessageConfigFilePath.ps1 b/ScriptMessage/Public/Set-ScriptMessageConfigFilePath.ps1 index 0333c40..061d1a4 100644 --- a/ScriptMessage/Public/Set-ScriptMessageConfigFilePath.ps1 +++ b/ScriptMessage/Public/Set-ScriptMessageConfigFilePath.ps1 @@ -11,7 +11,7 @@ function Set-ScriptMessageConfigFilePath Set the path to your ScriptMessage configuration file. The configuration holds general settings for the ScriptMessage module to use, as well as the connection information for the messaging service(s) you are using. - .PARAMETER Service + .PARAMETER Path Specify the path to where your configuration file is located. .EXAMPLE