GitHub/Actions/HelpOutAction.ps1
|
<# .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, # The name of the module for which types and formats are being generated. # If not provided, this will be assumed to be the name of the root directory. [string] $ModuleName, # 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) { "::notice title=No Branch Found::Not on a Branch. Exiting" | Out-Host return } $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-String } 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 $processScriptOutput = { process { $out = $_ $outItem = Get-Item -Path $out -ErrorAction SilentlyContinue $fullName, $shouldCommit = if ($out -is [IO.FileInfo]) { $out.FullName, (git status $out.Fullname -s) } elseif ($outItem) { $outItem.FullName, (git status $outItem.Fullname -s) } if ($shouldCommit) { git add $fullName if ($out.Message) { git commit -m "$($out.Message)" } elseif ($out.CommitMessage) { git commit -m "$($out.CommitMessage)" } elseif ($gitHubEvent.head_commit.message) { git commit -m "$($gitHubEvent.head_commit.message)" } $anyFilesChanged = $true } $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" } git pull | Out-Host $HelpOutScriptStart = [DateTime]::Now if ($HelpOutScript) { Invoke-Expression -Command $HelpOutScript | . $processScriptOutput | Out-Host } $HelpOutScriptTook = [Datetime]::Now - $HelpOutScriptStart "::set-output name=HelpOutScriptRuntime::$($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 | . $processScriptOutput | Out-Host } } } $HelpOutPS1EndStart = [DateTime]::Now $HelpOutPS1Took = [Datetime]::Now - $HelpOutPS1Start "::set-output name=HelpOutPS1Count::$($HelpOutPS1List.Length)" | Out-Host "::set-output name=HelpOutPS1Files::$($HelpOutPS1List -join ';')" | Out-Host "::set-output name=HelpOutPS1Runtime::$($HelpOutPS1Took.TotalMilliseconds)" | Out-Host if ($CommitMessage -or $anyFilesChanged) { if ($CommitMessage) { dir $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 if (-not $LASTEXITCODE) { "::notice::Pulling Changes" | Out-Host git pull | Out-Host "::notice::Pushing Changes" | Out-Host git push "Git Push Output: $($gitPushed | Out-String)" } else { "::notice::Not pushing changes (on detached head)" | Out-Host $LASTEXITCODE = 0 exit 0 } } |