Skip to content

Add log grouping to build.psm1 for collapsible GitHub Actions logs #26326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TravisEz13 merged 10 commits into from
Oct 29, 2025
Merged

Add log grouping to build.psm1 for collapsible GitHub Actions logs #26326

Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1436fb1
Initial plan
Copilot Oct 28, 2025
db65b5a
Add Write-LogGroupStart/End to build.psm1 for better GitHub Actions l…
Copilot Oct 28, 2025
608642c
Remove per-project log grouping in Restore-PSPackage
Copilot Oct 28, 2025
071a83c
Remove nested and small log groups per review feedback
Copilot Oct 28, 2025
aeebff2
Add log grouping guidelines instruction file
Copilot Oct 28, 2025
49b2b17
Apply suggestion from @TravisEz13
TravisEz13 Oct 28, 2025
eec8d28
Refactor logging for cleaning working directory
TravisEz13 Oct 29, 2025
04b2833
Add Show-Environment function and fix buildModuleChanged conditions
Copilot Oct 29, 2025
64db528
Merge branch 'master' into copilot/format-logs-in-github-workflows
TravisEz13 Oct 29, 2025
4241763
Update .github/instructions/log-grouping-guidelines.instructions.md
TravisEz13 Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion build.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,13 +536,17 @@ Fix steps:
}

# handle Restore
Write-LogGroupStart -Title "Restore NuGet Packages"
Restore-PSPackage -Options $Options -Force:$Restore -InteractiveAuth:$InteractiveAuth
Write-LogGroupEnd -Title "Restore NuGet Packages"

# handle ResGen
# Heuristic to run ResGen on the fresh machine
if ($ResGen -or -not (Test-Path "$PSScriptRoot/src/Microsoft.PowerShell.ConsoleHost/gen")) {
Write-LogGroupStart -Title "Generate Resource Files (ResGen)"
Write-Log -message "Run ResGen (generating C# bindings for resx files)"
Start-ResGen
Write-LogGroupEnd -Title "Generate Resource Files (ResGen)"
Comment thread
TravisEz13 marked this conversation as resolved.
Outdated
}

# Handle TypeGen
Expand All @@ -554,8 +558,10 @@ Fix steps:

$incFileName = "powershell_$runtime.inc"
if ($TypeGen -or -not (Test-Path "$PSScriptRoot/src/TypeCatalogGen/$incFileName")) {
Write-LogGroupStart -Title "Generate Type Catalog (TypeGen)"
Write-Log -message "Run TypeGen (generating CorePsTypeCatalog.cs)"
Start-TypeGen -IncFileName $incFileName
Write-LogGroupEnd -Title "Generate Type Catalog (TypeGen)"
Comment thread
TravisEz13 marked this conversation as resolved.
Outdated
}

# Get the folder path where pwsh.exe is located.
Expand All @@ -566,6 +572,7 @@ Fix steps:
$publishPath = $Options.Output
}

Write-LogGroupStart -Title "Build PowerShell"
try {
# Relative paths do not work well if cwd is not changed to project
Push-Location $Options.Top
Expand Down Expand Up @@ -620,13 +627,15 @@ Fix steps:
} finally {
Pop-Location
}
Write-LogGroupEnd -Title "Build PowerShell"

# No extra post-building task will run if '-SMAOnly' is specified, because its purpose is for a quick update of S.M.A.dll after full build.
if ($SMAOnly) {
return
}

# publish reference assemblies
Write-LogGroupStart -Title "Publish Reference Assemblies"
try {
Push-Location "$PSScriptRoot/src/TypeCatalogGen"
$refAssemblies = Get-Content -Path $incFileName | Where-Object { $_ -like "*microsoft.netcore.app*" } | ForEach-Object { $_.TrimEnd(';') }
Expand All @@ -640,6 +649,7 @@ Fix steps:
} finally {
Pop-Location
}
Write-LogGroupEnd -Title "Publish Reference Assemblies"

if ($ReleaseTag) {
$psVersion = $ReleaseTag
Expand Down Expand Up @@ -682,10 +692,13 @@ Fix steps:
# download modules from powershell gallery.
# - PowerShellGet, PackageManagement, Microsoft.PowerShell.Archive
if ($PSModuleRestore) {
Write-LogGroupStart -Title "Restore PowerShell Modules"
Restore-PSModuleToBuild -PublishPath $publishPath
Write-LogGroupEnd -Title "Restore PowerShell Modules"
}

# publish powershell.config.json
Write-LogGroupStart -Title "Generate PowerShell Configuration"
$config = [ordered]@{}

if ($Options.Runtime -like "*win*") {
Expand Down Expand Up @@ -731,10 +744,13 @@ Fix steps:
} else {
Write-Warning "No powershell.config.json generated for $publishPath"
}
Write-LogGroupEnd -Title "Generate PowerShell Configuration"

# Restore the Pester module
if ($CI) {
Write-LogGroupStart -Title "Restore Pester Module"
Restore-PSPester -Destination (Join-Path $publishPath "Modules")
Write-LogGroupEnd -Title "Restore Pester Module"
}

Clear-NativeDependencies -PublishFolder $publishPath
Expand Down Expand Up @@ -908,6 +924,8 @@ function Restore-PSPackage

$ProjectDirs | ForEach-Object {
$project = $_
$projectName = Split-Path -Leaf -Path $project
Write-LogGroupStart -Title "Restore Project: $projectName"
Write-Log -message "Run dotnet restore $project $RestoreArguments"
$retryCount = 0
$maxTries = 5
Expand All @@ -929,7 +947,6 @@ function Restore-PSPackage
$null = New-Item -path $env:OB_OUTPUTDIRECTORY -ItemType Directory -Force -Verbose
}

$projectName = Split-Path -Leaf -Path $project
$binlogFileName = "${projectName}.msbuild.binlog"
if ($IsMacOS) {
$resolvedPath = (Resolve-Path -Path ./msbuild.binlog).ProviderPath
Expand All @@ -940,6 +957,7 @@ function Restore-PSPackage
}
}

Write-LogGroupEnd -Title "Restore Project: $projectName"
throw
}
continue
Expand All @@ -948,6 +966,7 @@ function Restore-PSPackage
Write-Log -message "Done restoring $project"
break
}
Write-LogGroupEnd -Title "Restore Project: $projectName"
}
}
}
Expand Down Expand Up @@ -2086,6 +2105,7 @@ function Install-Dotnet {
[string]$FeedCredential
)

Write-LogGroupStart -Title "Install .NET SDK $Version"
Write-Verbose -Verbose "In install-dotnet"

# This allows sudo install to be optional; needed when running in containers / as root
Expand Down Expand Up @@ -2220,6 +2240,7 @@ function Install-Dotnet {
}
}
}
Write-LogGroupEnd -Title "Install .NET SDK $Version"
}

function Get-RedHatPackageManager {
Expand Down Expand Up @@ -2291,6 +2312,7 @@ function Start-PSBootstrap {
[string]$Scenario = "Package"
)

Write-LogGroupStart -Title "Bootstrap PowerShell Build Dependencies"
Comment thread
TravisEz13 marked this conversation as resolved.
Outdated
Write-Log -message "Installing PowerShell build dependencies"

Push-Location $PSScriptRoot/tools
Expand All @@ -2301,12 +2323,14 @@ function Start-PSBootstrap {

try {
if ($environment.IsLinux -or $environment.IsMacOS) {
Write-LogGroupStart -Title "Install Native Dependencies"
# This allows sudo install to be optional; needed when running in containers / as root
# Note that when it is null, Invoke-Expression (but not &) must be used to interpolate properly
$sudo = if (!$NoSudo) { "sudo" }

if ($BuildLinuxArm -and $environment.IsLinux -and -not $environment.IsUbuntu -and -not $environment.IsMariner) {
Write-Error "Cross compiling for linux-arm is only supported on AzureLinux/Ubuntu environment"
Write-LogGroupEnd -Title "Install Native Dependencies"
return
}

Expand Down Expand Up @@ -2425,9 +2449,11 @@ function Start-PSBootstrap {
}
}
}
Write-LogGroupEnd -Title "Install Native Dependencies"
}

if ($Scenario -in 'All', 'Both', 'DotNet') {
Write-LogGroupStart -Title "Install .NET SDK"

Write-Verbose -Verbose "Calling Find-Dotnet from Start-PSBootstrap"

Expand Down Expand Up @@ -2466,10 +2492,12 @@ function Start-PSBootstrap {
else {
Write-Log -message "dotnet is already installed. Skipping installation."
}
Write-LogGroupEnd -Title "Install .NET SDK"
}

# Install Windows dependencies if `-Package` or `-BuildWindowsNative` is specified
if ($environment.IsWindows) {
Write-LogGroupStart -Title "Install Windows Dependencies"
## The VSCode build task requires 'pwsh.exe' to be found in Path
if (-not (Get-Command -Name pwsh.exe -CommandType Application -ErrorAction Ignore))
{
Expand All @@ -2482,9 +2510,11 @@ function Start-PSBootstrap {
$isArm64 = "$env:RUNTIME" -eq 'arm64'
Install-Wix -arm64:$isArm64
}
Write-LogGroupEnd -Title "Install Windows Dependencies"
}

if ($Scenario -in 'All', 'Tools') {
Write-LogGroupStart -Title "Install .NET Global Tools"
Write-Log -message "Installing .NET global tools"

# Ensure dotnet is available
Expand All @@ -2495,16 +2525,20 @@ function Start-PSBootstrap {
Start-NativeExecution {
dotnet tool install --global dotnet-format
}
Write-LogGroupEnd -Title "Install .NET Global Tools"
}

if ($env:TF_BUILD) {
Write-LogGroupStart -Title "Capture NuGet Sources"
Write-Verbose -Verbose "--- Start - Capturing nuget sources"
dotnet nuget list source --format detailed
Write-Verbose -Verbose "--- End - Capturing nuget sources"
Write-LogGroupEnd -Title "Capture NuGet Sources"
}
} finally {
Pop-Location
}
Write-LogGroupEnd -Title "Bootstrap PowerShell Build Dependencies"
}

## If the required SDK version is found, return it.
Expand Down
Loading