-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
action.yml
348 lines (301 loc) · 12.8 KB
/
action.yml
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
name: DemoPowerShell
description: Make Demos of your PowerShell projects.
inputs:
ShowDemoScript:
required: false
description: |
A PowerShell Script that uses ShowDemo.
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.
SkipShowDemoPS1:
required: false
description: 'If set, will not process any files named *.ShowDemo.ps1'
ModuleName:
required: false
description: |
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.
CommitMessage:
required: false
description: If provided, will commit any remaining changes made to the workspace with this commit message.
UserEmail:
required: false
description: The user email associated with a git commit.
UserName:
required: false
description: The user name associated with a git commit.
branding:
icon: terminal
color: blue
runs:
using: composite
steps:
- name: DemoPowerShell
id: DemoPowerShell
shell: pwsh
env:
UserEmail: ${{inputs.UserEmail}}
SkipShowDemoPS1: ${{inputs.SkipShowDemoPS1}}
ModuleName: ${{inputs.ModuleName}}
UserName: ${{inputs.UserName}}
ShowDemoScript: ${{inputs.ShowDemoScript}}
CommitMessage: ${{inputs.CommitMessage}}
run: |
$Parameters = @{}
$Parameters.ShowDemoScript = ${env:ShowDemoScript}
$Parameters.SkipShowDemoPS1 = ${env:SkipShowDemoPS1}
$Parameters.SkipShowDemoPS1 = $parameters.SkipShowDemoPS1 -match 'true';
$Parameters.ModuleName = ${env:ModuleName}
$Parameters.CommitMessage = ${env:CommitMessage}
$Parameters.UserEmail = ${env:UserEmail}
$Parameters.UserName = ${env:UserName}
foreach ($k in @($parameters.Keys)) {
if ([String]::IsNullOrEmpty($parameters[$k])) {
$parameters.Remove($k)
}
}
Write-Host "::debug:: DemoPowerShell $(@(foreach ($p in $Parameters.GetEnumerator()) {'-' + $p.Key + ' ' + $p.Value}) -join ' ')"
& {<#
.Synopsis
GitHub Action for ShowDemo
.Description
GitHub Action for ShowDemo. This will:
* Import ShowDemo
* Get all demos in the current directory
* Export each demo to a markdown file.
* Run any .ShowDemo.ps1 scripts
* Run the content of the .ShowDemoScript 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 ShowDemo.
# 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]
$ShowDemoScript,
# If set, will not process any files named *.ShowDemo.ps1
[switch]
$SkipShowDemoPS1,
# 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.
[string]
$CommitMessage,
# The user email associated with a git commit.
[string]
$UserEmail,
# The user name associated with a git commit.
[string]
$UserName
)
#region Initial Logging
# Output the parameters passed to this script (for debugging)
"::group::Parameters" | Out-Host
[PSCustomObject]$PSBoundParameters | Format-List | Out-Host
"::endgroup::" | Out-Host
# Get the GitHub Event
$gitHubEvent =
if ($env:GITHUB_EVENT_PATH) {
[IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json
} else { $null }
# Log the GitHub Event
@"
::group::GitHubEvent
$($gitHubEvent | ConvertTo-Json -Depth 100)
::endgroup::
"@ | Out-Host
# Check that there is a workspace (and throw if there is not)
if (-not $env:GITHUB_WORKSPACE) { throw "No GitHub workspace" }
#endregion Initial Logging
# Check to ensure we are on a branch
$branchName = git rev-parse --abrev-ref HEAD
# If we were not, return.
if (-not $branchName) {
"::warning::Not on a branch" | Out-Host
return
}
#region Configure UserName and Email
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
#endregion Configure UserName and Email
git pull | Out-Host
#region Load Action Module
$ActionModuleName = "ShowDemo"
$ActionModuleFileName = "$ActionModuleName.psd1"
# Try to find a local copy of the action's module.
# This allows the action to use the current branch's code instead of the action's implementation.
$PSD1Found = Get-ChildItem -Recurse -Filter "*.psd1" |
Where-Object Name -eq $ActionModuleFileName |
Select-Object -First 1
$ActionModulePath, $ActionModule =
# If there was a .PSD1 found
if ($PSD1Found) {
$PSD1Found.FullName # import from there.
Import-Module $PSD1Found.FullName -Force -PassThru
}
# Otherwise, if we have a GITHUB_ACTION_PATH
elseif ($env:GITHUB_ACTION_PATH)
{
$actionModulePath = Join-Path $env:GITHUB_ACTION_PATH $ActionModuleFileName
if (Test-path $actionModulePath) {
$actionModulePath
Import-Module $actionModulePath -Force -PassThru
} else {
throw "$actionModuleName not found"
}
}
elseif (-not (Get-Module $ActionModuleName)) {
throw "$actionModulePath could not be loaded."
}
"::notice title=ModuleLoaded::$actionModuleName Loaded from Path - $($actionModulePath)" | Out-Host
#endregion Load Action Module
#region Install/Import Other Modules
@"
::group::Installing Modules
$(
"Installing ugit" | Out-Host
Install-Module -Name ugit -Scope CurrentUser -Force
"Importing ugit" | Out-Host
Import-Module ugit -Force -PassThru -Global | Out-Host
)
::endgroup::
"@ | Out-Host
#endregion Install Other Modules
#region Declare Functions and Variables
$anyFilesChanged = $false
filter ProcessScriptOutput {
$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 ($out.SourceFile) {
"Source File: $($out.SourceFile)" | Out-Host
$lastCommitMessage = $out.SourceFile |
git log -n 1 |
Select-Object -ExpandProperty CommitMessage
if ($lastCommitMessage) {
git commit -m $lastCommitMessage
}
} elseif ($gitHubEvent.head_commit.message) {
git commit -m "$($gitHubEvent.head_commit.message)"
}
$anyFilesChanged = $true
}
$out
}
#endregion Declare Functions and Variables
#region Actual Action
$ShowDemoScriptStart = [DateTime]::Now
if ($ShowDemoScript) {
Invoke-Expression -Command $ShowDemoScript |
. processScriptOutput |
Out-Host
}
$ShowDemoScriptTook = [Datetime]::Now - $ShowDemoScriptStart
$ShowDemoPS1Start = [DateTime]::Now
$ShowDemoPS1List = @()
if (-not $SkipShowDemoPS1) {
$ShowDemoFiles = @(
Get-ChildItem -Recurse -Path $env:GITHUB_WORKSPACE |
Where-Object Name -Match '\.ShowDemo\.ps1$')
if ($ShowDemoFiles) {
$ShowDemoFiles|
ForEach-Object {
$ShowDemoPS1List += $_.FullName.Replace($env:GITHUB_WORKSPACE, '').TrimStart('/')
$ShowDemoPS1Count++
"::notice title=Running::$($_.Fullname)" | Out-Host
. $_.FullName |
. processScriptOutput |
Out-Host
}
}
}
"Fetching Changes" | Out-Host
git fetch --unshallow | Out-Host
#region Export-Demo
"Looking for demos in $env:GITHUB_WORKSPACE" | Out-Host
Get-ChildItem -Path $env:GITHUB_WORKSPACE -Recurse -Filter *.ps1 |
Where-Object Name -Match '(?<=\.|^)(?>demo|walkthru)\.ps1$' |
ForEach-Object {
$demoFile = $_
$demoFileOut =
$demoFile |
Export-Demo -OutputPath {
$_.FullName -replace '\.ps1$', '.md'
}
$lastCommitMessage =
git log $demoFile.FullName |
Select-Object -ExpandProperty CommitMessage -First 1
"LastCommitMessage for $($demoFile.Name): $lastcommitMessage" | Out-Host
$demoFileOut |
Add-Member NoteProperty CommitMessage $lastCommitMessage -Force -PassThru |
. processScriptOutput
}
#endregion Export-Demo
$ShowDemoPS1EndStart = [DateTime]::Now
$ShowDemoPS1Took = [Datetime]::Now - $ShowDemoPS1Start
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 Updates" | Out-Host
git pull
"::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
}
}
#endregion Actual Action
} @Parameters