Skip to content

Remove Uninstall parameter documentation from Install-SqlDscServer#2398

Merged
johlju merged 2 commits intomainfrom
copilot/remove-uninstall-parameter
Jan 4, 2026
Merged

Remove Uninstall parameter documentation from Install-SqlDscServer#2398
johlju merged 2 commits intomainfrom
copilot/remove-uninstall-parameter

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 4, 2026

The Install-SqlDscServer command documented an Uninstall parameter in its comment-based help that doesn't exist in the actual parameter block. This creates confusion since uninstall operations should use the dedicated Uninstall-SqlDscServer command.

Changes

  • Removed .PARAMETER Uninstall documentation from Install-SqlDscServer.ps1 comment-based help
  • Updated CHANGELOG.md

The command never accepted an Uninstall parameter—only the internal Invoke-SetupAction function does. Documentation now accurately reflects the public API surface.

Original prompt

This section details on the original issue you should resolve

<issue_title>Remove Uninstall parameter from Install-SqlDscServer command</issue_title>
<issue_description>### Problem description

The Install-SqlDscServer command currently has an Uninstall parameter, however, there is already a dedicated Uninstall-SqlDscServer command. This is redundant and may lead to confusion for users. The parameter Uninstall should be removed from Install-SqlDscServer, and the comment-based help should be updated accordingly.

Verbose logs

N/A – This is a code/service design inconsistency, not a runtime error.

How to reproduce

  1. Open the module file for Install-SqlDscServer.
  2. Observe that it exposes an 'Uninstall' parameter even though there is a separate Uninstall-SqlDscServer command.

Expected behavior

The Install-SqlDscServer command should not have an Uninstall parameter. Users should use the Uninstall-SqlDscServer command for uninstall operations.

Current behavior

The Install-SqlDscServer command currently exposes an Uninstall parameter, which suggests that Install-SqlDscServer can also perform uninstall operations, overlapping with Uninstall-SqlDscServer and potentially causing confusion.

Suggested solution

Remove the Uninstall parameter from the Install-SqlDscServer command and update comment-based help/documentation accordingly so that uninstall actions are only performed using the Uninstall-SqlDscServer command.

Operating system the target node is running

N/A – not node or OS specific, module code/design only.

PowerShell version and build the target node is running

N/A – not node or PowerShell version specific, module code/design only.

Module version used

Main (current development branch) at time of proposal.
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


This change is Reviewable

Copilot AI self-assigned this Jan 4, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 4, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Co-authored-by: johlju <7189721+johlju@users.noreply.github.com>
@johlju johlju marked this pull request as ready for review January 4, 2026 10:27
@johlju johlju requested review from a team and johlju as code owners January 4, 2026 10:27
Copy link
Copy Markdown
Member

@johlju johlju left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

@johlju reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @copilot[bot]).

Copilot AI changed the title [WIP] Remove uninstall parameter from Install-SqlDscServer command Remove Uninstall parameter documentation from Install-SqlDscServer Jan 4, 2026
Copilot AI requested a review from johlju January 4, 2026 10:29
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94%. Comparing base (4904751) to head (0ac06fb).
⚠️ Report is 32 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #2398   +/-   ##
=====================================
  Coverage     94%     94%           
=====================================
  Files        186     186           
  Lines      10238   10238           
=====================================
  Hits        9633    9633           
  Misses       605     605           
Flag Coverage Δ
unit 94% <ø> (ø)
Files with missing lines Coverage Δ
source/Public/Install-SqlDscServer.ps1 100% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@johlju johlju merged commit fae5bdb into main Jan 4, 2026
32 checks passed
@johlju johlju deleted the copilot/remove-uninstall-parameter branch January 4, 2026 15:40
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.

Remove Uninstall parameter from Install-SqlDscServer command

2 participants