azure-sdk-for-rust: Instructions file for GitHub Copilot

PowerShell Script Instructions

Path Handling

• Always use [System.IO.Path]::Combine instead of Join-Path
  • Use the full form: ([System.IO.Path]::Combine($path1, $path2, ...))
  • Example: ([System.IO.Path]::Combine($PSScriptRoot, '..', 'common', 'scripts', 'common.ps1'))
  • This ensures consistent path handling across all platforms

Command Invocation

• Use Invoke-LoggedCommand for invoking external commands
  • Commands should be logged unless they output to stderr that needs to be processed
  • Use -GroupOutput to collapse output in CI logs
  • Use -DoNotExitOnFailedExitCode when you need to handle exit codes manually
  • Example: Invoke-LoggedCommand "cargo build --keep-going" -GroupOutput
  • Example with error handling: Invoke-LoggedCommand "cargo test ..." -GroupOutput -DoNotExitOnFailedExitCode

Output Grouping

• Use LogGroupStart and LogGroupEnd to collapse verbose output
  • Use for output that is verbose or not relevant in most cases (e.g., large JSON dumps, detailed test output)
  • Example:

    LogGroupStart "Raw JSON Output"
    Get-Content $jsonFile | ForEach-Object { Write-Host $_ }
    LogGroupEnd
    

Console Output

• Do not use emojis in console output
  • Use plain text instead
  • Bad: Write-Host "✅ Tests passed"
  • Good: Write-Host "Tests passed"

Code Organization

• Extract common code patterns into functions
  • If you see similar code blocks repeated, extract them into a reusable function
  • Functions should have clear parameters and return values
  • Example: Extract test execution logic into a shared function rather than duplicating it
• Do not modify eng/common scripts directly
  • Treat eng/common/ as shared upstream engineering infrastructure
  • Add repository-specific helpers under eng/scripts/shared/ instead of changing eng/common/ directly
• Use eng/scripts/shared/common.ps1 for repository-specific shared helpers
  • Add new helper imports there and have scripts import that file rather than dot-sourcing multiple repo-local helper files individually
  • Put new functions in new or existing helper files under eng/scripts/shared/ as appropriate