GitHub/Actions/HelpOutAction.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
<# .Synopsis GitHub Action for HelpOut .Description GitHub Action for HelpOut. This will: * Import HelpOut * Run all *.HelpOut.ps1 files beneath the workflow directory * Run a .HelpOutScript parameter Any files changed can be outputted by the script, and those changes can be checked back into the repo. Make sure to use the "persistCredentials" option with checkout. #> param( # A PowerShell Script that uses HelpOut. # Any files outputted from the script will be added to the repository. # If those files have a .Message attached to them, they will be committed with that message. [string] $HelpOutScript, # If set, will not process any files named *.HelpOut.ps1 [switch] $SkipHelpOutPS1, # A list of modules to be installed from the PowerShell gallery before scripts run. [string[]] $InstallModule = @("ugit"), # If provided, will commit any remaining changes made to the workspace with this commit message. # If no commit message is provided, changes will not be committed. [string] $CommitMessage, # The user email associated with a git commit. [string] $UserEmail, # The user name associated with a git commit. [string] $UserName ) "::group::Parameters" | Out-Host [PSCustomObject]$PSBoundParameters | Format-List | Out-Host "::endgroup::" | Out-Host $gitHubEvent = if ($env:GITHUB_EVENT_PATH) { [IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json } else { $null } @" ::group::GitHubEvent $($gitHubEvent | ConvertTo-Json -Depth 100) ::endgroup:: "@ | Out-Host # Check to ensure we are on a branch $branchName = git rev-parse --abrev-ref HEAD # If we were not, return. if ((-not $branchName) -or $LASTEXITCODE) { $LASTEXITCODE = 0 "::warning title=No Branch Found::Not on a Branch. Can not run." | Out-Host exit 0 return } $repoRoot = (git rev-parse --show-toplevel *>&1) -replace '/', [IO.Path]::DirectorySeparatorChar # Use ANSI rendering if available if ($PSStyle.OutputRendering) { $PSStyle.OutputRendering = 'ANSI' } #region -InstallModule if ($InstallModule) { "::group::Installing Modules" | Out-Host foreach ($moduleToInstall in $InstallModule) { $moduleInWorkspace = Get-ChildItem -Path $env:GITHUB_WORKSPACE -Recurse -File | Where-Object Name -eq "$($moduleToInstall).psd1" | Where-Object { $(Get-Content $_.FullName -Raw) -match 'ModuleVersion' } if (-not $moduleInWorkspace) { Install-Module $moduleToInstall -Scope CurrentUser -Force Import-Module $moduleToInstall -Force -PassThru | Out-Host } } "::endgroup::" | Out-Host } #endregion -InstallModule $PSD1Found = Get-ChildItem -Recurse -Filter "*.psd1" | Where-Object Name -eq 'HelpOut.psd1' | Select-Object -First 1 if ($PSD1Found) { $PipeScriptModulePath = $PSD1Found Import-Module $PSD1Found -Force -PassThru | Out-Host } elseif ($env:GITHUB_ACTION_PATH) { $HelpOutModulePath = Join-Path $env:GITHUB_ACTION_PATH 'HelpOut.psd1' if (Test-path $HelpOutModulePath) { Import-Module $HelpOutModulePath -Force -PassThru | Out-Host } else { throw "HelpOut not found" } } elseif (-not (Get-Module HelpOut)) { throw "Action Path not found" } "::notice title=ModuleLoaded::HelpOut Loaded from Path - $($HelpOutModulePath)" | Out-Host $anyFilesChanged = $false $totalFilesOutputted = 0 $totalFilesChanged = 0 $filesOutputted = @() $filesChanged = @() filter ProcessActionOutput { $out = $_ $outItem = Get-Item -Path $out -ErrorAction SilentlyContinue $totalFilesOutputted++ $fullName, $shouldCommit = if ($out -is [IO.FileInfo]) { if ($out.FullName -notlike "$repoRoot*") { return } $out.FullName, (git status $out.Fullname -s) $filesOutputted += $out } elseif ($outItem) { if ($outItem.FullName -notlike "$repoRoot*") { return } $outItem.FullName, (git status $outItem.Fullname -s) $filesOutputted += $outItem } if ($shouldCommit) { git add $fullName $filesChanged += $fullName if ($out.Message) { git commit -m "$($out.Message)" | Out-Host } elseif ($out.CommitMessage) { git commit -m "$($out.CommitMessage)" | Out-Host } elseif ($gitHubEvent.head_commit.message) { git commit -m "$($gitHubEvent.head_commit.message)" | Out-Host } $anyFilesChanged = $true $totalFilesChanged++ } $out } if (-not $UserName) { $UserName = if ($env:GITHUB_TOKEN) { Invoke-RestMethod -uri "https://api.github.com/user" -Headers @{ Authorization = "token $env:GITHUB_TOKEN" } | Select-Object -First 1 -ExpandProperty name } else { $env:GITHUB_ACTOR } } if (-not $UserEmail) { $GitHubUserEmail = if ($env:GITHUB_TOKEN) { Invoke-RestMethod -uri "https://api.github.com/user/emails" -Headers @{ Authorization = "token $env:GITHUB_TOKEN" } | Select-Object -First 1 -ExpandProperty email } else {''} $UserEmail = if ($GitHubUserEmail) { $GitHubUserEmail } else { "$UserName@github.com" } } git config --global user.email $UserEmail git config --global user.name $UserName if (-not $env:GITHUB_WORKSPACE) { throw "No GitHub workspace" } $checkDetached = git symbolic-ref -q HEAD if (-not $LASTEXITCODE) { git pull | Out-Host } $HelpOutScriptStart = [DateTime]::Now if ($HelpOutScript) { Invoke-Expression -Command $HelpOutScript | . ProcessActionOutput | Out-Host } $HelpOutScriptTook = [Datetime]::Now - $HelpOutScriptStart "::notice title=Runtime::$($HelpOutScriptTook.TotalMilliseconds)" | Out-Host $HelpOutPS1Start = [DateTime]::Now $HelpOutPS1List = @() if (-not $SkipHelpOutPS1) { $HelpOutFiles = @( Get-ChildItem -Recurse -Path $env:GITHUB_WORKSPACE | Where-Object Name -Match '\.HelpOut\.ps1$') if ($HelpOutFiles) { $HelpOutFiles| ForEach-Object { $HelpOutPS1List += $_.FullName.Replace($env:GITHUB_WORKSPACE, '').TrimStart('/') $HelpOutPS1Count++ "::notice title=Running::$($_.Fullname)" | Out-Host . $_.FullName | . ProcessActionOutput | Out-Host } } } $HelpOutPS1EndStart = [DateTime]::Now $HelpOutPS1Took = [Datetime]::Now - $HelpOutPS1Start "Ran $($HelpOutPS1List.Length) Files in $($HelpOutPS1Took.TotalMilliseconds)" | Out-Host if ($filesChanged) { "::group::$($filesOutputted.Length) files generated with $($filesChanged.Length) changes" | Out-Host $FilesChanged -join ([Environment]::NewLine) | Out-Host "::endgroup::" | Out-Host } else { "$($filesOutputted.Length) files generated with no changes" } if ($CommitMessage -or $anyFilesChanged) { if ($CommitMessage) { Get-ChildItem $env:GITHUB_WORKSPACE -Recurse | ForEach-Object { $gitStatusOutput = git status $_.Fullname -s if ($gitStatusOutput) { git add $_.Fullname } } git commit -m $ExecutionContext.SessionState.InvokeCommand.ExpandString($CommitMessage) } $checkDetached = git symbolic-ref -q HEAD 2>&1 if (-not $LASTEXITCODE) { "::group::Pulling Changes" | Out-Host git pull | Out-Host "::endgroup::" | Out-Host "::group::Pushing Changes" | Out-Host git push | Out-Host "::endgroup::" | Out-Host } else { "::warning title=Not pushing changes::(on detached head)" | Out-Host $LASTEXITCODE = 0 exit 0 } } else { "Nothing to commit in this build." | Out-Host exit 0 } |