Update internal PowerShell script documentation#1993
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates comment-based help and script documentation under src/scripts so Get-Help output and the scripts README better match the actual PowerShell parameters supported by the build/publish tooling.
Changes:
- Expanded
.PARAMETERdocumentation for several scripts (added missing parameters; removed non-existent ones). - Cleaned up wording/typos and reordered help sections for more accurate
Get-Helpoutput. - Updated
src/scripts/README.mdparameter table forPublish-Toolkit.ps1.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/scripts/README.md | Updates Publish-Toolkit parameter table to reflect current params and descriptions. |
| src/scripts/Publish-Toolkit.ps1 | Aligns comment-based help with actual params (adds AppInsightsRepo/DocsRepo, fixes wording, notes Branch alias). |
| src/scripts/Build-Bicep.ps1 | Adjusts Module parameter documentation and removes the documented Debug parameter. |
| src/scripts/Build-Workbook.ps1 | Moves/updates parameter help content and removes documented Debug parameter. |
| src/scripts/Invoke-Task.ps1 | Adds missing version-related parameter docs and removes the documented Silent parameter. |
| src/scripts/New-Directory.ps1 | Adds missing Path parameter documentation and fixes indentation/formatting. |
| src/scripts/Build-Toolkit.ps1 | Adds missing version-related parameter docs. |
| src/scripts/Build-PowerBI.ps1 | Fixes parameter names in help (no leading dashes) and clarifies optionality. |
- Add `rc` to Label allowed-values in Build-Toolkit.ps1 and Invoke-Task.ps1 - Add [CmdletBinding()] to Build-Bicep.ps1 for proper -Debug support 🤖 Generated with [Claude Code](https://claude.ai/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Collaborator
Author
|
🤖 [AI][Claude] PR Update Summary Addressed: 5 thread(s)
Changes:
Discussion items: Pushed back on changelog entry (internal-only change), Workbook param optionality (graceful handling), and Task param optionality (intentional no-op design). |
Clarify that a changelog entry is not required when the PR body contains the "[x] Log not needed" checklist item and the PR does not change any meaningful externally-facing functionality. 🤖 Generated with [Claude Code](https://claude.ai/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
RolandKrummenacher
approved these changes
Feb 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛠️ Description
Updated inline
.PARAMETERdocumentation in PowerShell scripts to match actual parameters. This ensuresGet-Helpoutput is accurate and consistent across all scripts.Changes
Publish-Toolkit.ps1AppInsightsRepoandDocsRepoparams; fixed "the the" typo; added alias note for BranchBuild-Bicep.ps1Debugparam that doesn't exist; clarifiedModuledescriptionBuild-Workbook.ps1.PARAMETERorder (should come before.EXAMPLE); removed nonexistentDebugparamInvoke-Task.ps1Major,Minor,Patch,Prerelease,Label,Version); removedSilentparam that doesn't existNew-Directory.ps1Pathparam; fixed indentation formattingBuild-Toolkit.ps1Major,Minor,Patch,Prerelease,Label)Build-PowerBI.ps1-KQL→KQL,-Storage→Storage); added "Optional." prefixREADME.md📋 Checklist
🔬 How did you test this change?
🙋♀️ Do any of the following that apply?
📑 Did you update
docs/changelog.md?📖 Did you update documentation?
🤖 Generated with Claude Code