Skip to content

Update internal PowerShell script documentation#1993

Merged
flanakin merged 3 commits intodevfrom
flanakin/ps-internal
Feb 23, 2026
Merged

Update internal PowerShell script documentation#1993
flanakin merged 3 commits intodevfrom
flanakin/ps-internal

Conversation

@flanakin
Copy link
Collaborator

🛠️ Description

Updated inline .PARAMETER documentation in PowerShell scripts to match actual parameters. This ensures Get-Help output is accurate and consistent across all scripts.

Changes

Script Issues Fixed
Publish-Toolkit.ps1 Added missing AppInsightsRepo and DocsRepo params; fixed "the the" typo; added alias note for Branch
Build-Bicep.ps1 Removed documented Debug param that doesn't exist; clarified Module description
Build-Workbook.ps1 Fixed .PARAMETER order (should come before .EXAMPLE); removed nonexistent Debug param
Invoke-Task.ps1 Added 6 missing params (Major, Minor, Patch, Prerelease, Label, Version); removed Silent param that doesn't exist
New-Directory.ps1 Added missing Path param; fixed indentation formatting
Build-Toolkit.ps1 Added 5 missing params (Major, Minor, Patch, Prerelease, Label)
Build-PowerBI.ps1 Removed leading dashes from param names (-KQLKQL, -StorageStorage); added "Optional." prefix
README.md Updated Publish-Toolkit table with missing params and fixed alignment

📋 Checklist

🔬 How did you test this change?

  • 🤏 Lint tests

🙋‍♀️ Do any of the following that apply?

  • 🤏 The change is less than 20 lines of code.

📑 Did you update docs/changelog.md?

  • ❎ Log not needed (small/internal change)

📖 Did you update documentation?

  • ✅ Internal dev docs in src (required for dev)

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings February 11, 2026 17:12
@microsoft-github-policy-service microsoft-github-policy-service bot added Micro PR 🔬 Very small PR that should be especially easy for newcomers Needs: Review 👀 PR that is ready to be reviewed labels Feb 11, 2026
@microsoft-github-policy-service microsoft-github-policy-service bot added the Skill: DevOps GitHub setup and automation label Feb 11, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 .PARAMETER documentation for several scripts (added missing parameters; removed non-existent ones).
  • Cleaned up wording/typos and reordered help sections for more accurate Get-Help output.
  • Updated src/scripts/README.md parameter table for Publish-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.

@flanakin flanakin added this to the v14 milestone Feb 13, 2026
- 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>
@flanakin flanakin requested a review from MSBrett as a code owner February 23, 2026 11:08
@flanakin
Copy link
Collaborator Author

🤖 [AI][Claude] PR Update Summary

Addressed: 5 thread(s)

  • ✅ Implemented: 2
  • 🤔 Needs discussion: 3
  • ❓ Questions: 0

Changes:

  • Added rc to Label allowed-values in Build-Toolkit.ps1 and Invoke-Task.ps1 to match Update-Version.ps1
  • Added [CmdletBinding()] to Build-Bicep.ps1 for proper -Debug common parameter support

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>
@flanakin flanakin enabled auto-merge (squash) February 23, 2026 11:17
@flanakin flanakin merged commit 9afa6b3 into dev Feb 23, 2026
4 checks passed
@flanakin flanakin deleted the flanakin/ps-internal branch February 23, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Micro PR 🔬 Very small PR that should be especially easy for newcomers Needs: Review 👀 PR that is ready to be reviewed Skill: DevOps GitHub setup and automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants