Awesome Reviewers expert instructions

domains / cloud-infra / Azure/azure-powershell

Production-Safe Configuration

When changing build/test/configuration files, ensure they are (1) platform-correct and (2) production-safe. Apply this standard: 1) Platform-correct environment/config updates

raw .md Configurations Yaml updated

When changing build/test/configuration files, ensure they are (1) platform-correct and (2) production-safe.

Apply this standard: 1) Platform-correct environment/config updates

  • When appending to env vars that are path lists (e.g., PSModulePath), use the platform’s path separator rather than hard-coding : or ;.

2) Gate/disable debug output in production

  • Avoid enabling debug: true (or equivalent flags like --debug) in configs used to generate production artifacts. If needed, enable it only for non-production builds (or via a parameter/flag), because debug output can increase generated code size and noise.

Example (pattern):

# Prefer parameters/env gating for debug
steps:
- powershell: |
    Install-Module -Name Pester -RequiredVersion 4.10.1 -Force
    $sep = [System.IO.Path]::PathSeparator
    $env:PSModulePath = $env:PSModulePath + $sep + (pwd).Path
  condition: eq('${{ parameters.testTarget }}', 'Test')
  continueOnError: true
# In autorest/tspconfig.yaml-like configs: keep debug off unless explicitly requested
options:
  "@azure-tools/typespec-powershell":
    debug: false

Checklist before merging:

  • Are any env/path operations using OS-specific separators? If yes, switch to a platform-aware approach.
  • Are any debug/diagnostic flags enabled by default? If yes, disable or gate them for non-production only.
Source discussions