Skip to content

Fix package review findings before the 0.5.0 release - #36

Merged
christaylorcodes merged 2 commits into
masterfrom
fix/0.5.0-package-review
Nov 12, 2026
Merged

christaylorcodes merged 2 commits into
masterfrom
fix/0.5.0-package-review

Conversation

@christaylorcodes

@christaylorcodes christaylorcodes commented Nov 11, 2026 •

Copy link
Copy Markdown
Owner

Fixes what a review of the built 0.5.0 package found before release. Merging this publishes nothing; no tag is pushed.

The review compared the .nupkg from the release dry run with 0.4.0.0 from the Gallery, on PowerShell 7 and Windows PowerShell 5.1.

Fixes that change the module

  • Connect-CWC 'server' $cred works again. Adding the sign-in parameter sets had removed the positions, so a 0.4-style positional call failed with PositionalParameterNotFound. -Server is position 0 and -Credentials position 1 in every credential set. Secrets are never positional.
  • ErrorIds on Windows PowerShell 5.1. Get-CWCLastContact, Invoke-CWCCommand and Remove-CWCSessionNote re-reported a caught error with Write-Error $_, which on 5.1 replaces the ErrorId with WriteErrorException. They now use $PSCmdlet.WriteError($_), so CWC.NotConnected and the other CWC.* IDs survive on both editions.
  • about_ConnectWiseControlAPI has content. The topic shipped as an empty file. It now covers the three ways to sign in, the ErrorIds, the Remove-* confirmation and the upgrade notes.
  • Product name fixed in the help of Get-CWCLastContact and Update-CWCSessionName ("the control server").

Fix that changes the package

  • Gallery command tags. 0.4.0.0's package has PSIncludes_Function and a PSFunction_* / PSCommand_* tag per command; the Gallery lists and finds commands by them. PowerShellGet v2 added them while packing, and Publish-PSResource does not. A new build task (.build/gallery-tags.ps1) writes them into the built manifest (72 tags, 2107 of the 4000 characters allowed), and Build/Test-ReleasePackage.ps1 now fails if the package's .nuspec lacks any of them.

Documentation

  • CHANGELOG.md [0.5.0]:
    • New breaking-change entry: Get-CWCSession -Type Support / Meeting without -Group reads All Sessions / All Meetings, not All Machines.
    • Repository and tooling entries moved to a "Development" section at the end, so the release notes lead with what users need.
    • Three entries moved to the right heading, and the "same 32 functions" sentence replaced (0.4.0.0 had 21 commands).
    • The Remove-* confirmation entry now says what happens without -Confirm:$false in each kind of unattended host. A blank line on redirected input accepts the prompt's default, which is Yes.
    • The HTTP 500 entry is corrected: 0.4.0.0 had retry code that never ran, so retries for safe calls are new.
  • README.md: the intro no longer says existing scripts keep working without qualification; the upgrade list has the Get-CWCSession entry.

Not changed

No positional-parameter entry in the breaking changes, because the break is fixed, not documented.

Testing

  • ./Tests/test-local.ps1: all stages pass; 486 tests pass on both editions (9 new: positional connect, parameter positions, ErrorIds for the three functions, -ErrorAction Ignore, about topic, Gallery tags).
  • The ErrorId tests keep the error non-terminating. Run on 5.1 against the old code they fail (5 of 5), and against this branch they pass. A first version used -ErrorAction Stop and passed against the old code; a review caught that.
  • ErrorIds checked by hand on 5.1 before and after: WriteErrorException before, CWC.NotConnected after.
  • ./Build/Test-ReleasePackage.ps1 passes with the tag check: 0.5.0, 32 functions, no aliases or import warnings on both editions.
  • ./Build/Get-ReleaseInfo.ps1 -Tag v0.5.0 passes.

🤖 Generated with Claude Code

christaylorcodes and others added 2 commits November 10, 2026 21:45
- Connect-CWC accepts server and credentials by position again
- Keep CWC.* ErrorIds on Windows PowerShell 5.1 when a read fails
- Build adds the Gallery's command tags; the package check verifies them
- Write the about_ConnectWiseControlAPI help topic (it was empty)
- CHANGELOG: document the Get-CWCSession default group change and move
  repository entries to a Development section

Co-Authored-By: Claude <noreply@anthropic.com>
- ErrorId tests keep the error non-terminating, so they fail against
  Write-Error $_ on Windows PowerShell 5.1 (the first version did not)
- about topic, CHANGELOG, README: say what Remove-* does without
  -Confirm:$false in each kind of host; MFA-only ErrorIds are marked;
  the HTTP 500 note no longer claims 0.4 retried
- CHANGELOG: restore two entries dropped in the restructure

Co-Authored-By: Claude <noreply@anthropic.com>
@christaylorcodes
christaylorcodes merged commit f10cce0 into master Nov 12, 2026
9 of 10 checks passed
@christaylorcodes christaylorcodes mentioned this pull request Nov 12, 2026
8 of 13 tasks
@christaylorcodes
christaylorcodes deleted the fix/0.5.0-package-review branch November 12, 2026 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant