{{ message }}
Repository navigation
Expand file tree
/
Copy pathGithub.psm1
More file actions
321 lines (278 loc) · 9.78 KB
/
Copy pathGithub.psm1
File metadata and controls
321 lines (278 loc) · 9.78 KB
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
Join-Path $PSScriptRoot 'Helpers.psm1' | Import-Module
function Invoke-GithubRequest {
<#
.SYNOPSIS
Invoke authenticated github API request.
.PARAMETER Query
Query to be executed. `https://api/github.com/` is already included.
.PARAMETER Method
Method to be used with request.
.PARAMETER Body
Additional body to be send.
.EXAMPLE
Invoke-GithubRequest 'repos/User/Repo/pulls' -Method 'Post' -Body @{ 'body' = 'body' }
#>
param(
[Parameter(Mandatory)]
[String] $Query,
[Microsoft.PowerShell.Commands.WebRequestMethod] $Method = 'Get',
[Hashtable] $Body
)
$baseUrl = 'https://api.github.com'
$parameters = @{
'Headers' = @{
# Authorization token is neeeded for posting comments and to increase limit of requests
'Authorization' = "Bearer $env:GITHUB_TOKEN"
}
'Method' = $Method
'Uri' = "$baseUrl/$Query"
}
if ($Body) { $parameters.Add('Body', (ConvertTo-Json $Body -Depth 8 -Compress)) }
$env:GH_REQUEST_COUNTER = ([int] $env:GH_REQUEST_COUNTER) + 1
return Invoke-WebRequest @parameters
}
function Add-Comment {
<#
.SYNOPSIS
Add comment into specific issue / PR.
https://developer.github.com/v3/issues/comments/
.PARAMETER ID
ID of issue / PR.
.PARAMETER Message
String or array of strings to be send as comment. Array will be joined with CRLF.
.PARAMETER AppendLogLink
If set, link to current job log will be appended to comment.
#>
param(
[Parameter(Mandatory)]
[Int] $ID,
[Alias('Comment')]
[String[]] $Message,
[switch] $AppendLogLink
)
if ($AppendLogLink -and $Message) {
$Message += "`r`n[_Check the full log for details._]($(Get-LogURL -UseCache:$true))"
}
$resp = Invoke-GithubRequest -Query "repos/$REPOSITORY/issues/$ID/comments" -Method Post -Body @{ 'body' = ($Message -join "`r`n") }
}
function Get-AllChangedFilesInPR {
<#
.SYNOPSIS
Get all changed files inside pull request.
https://developer.github.com/v3/pulls/#list-pull-requests-files
.PARAMETER ID
ID of pull request.
.PARAMETER Filter
Return only files which are not 'removed'.
#>
param(
[Parameter(Mandatory)]
[Int] $ID,
[Switch] $Filter
)
$files = @()
$filesno = ((Invoke-GithubRequest -Query "repos/$REPOSITORY/pulls/$ID").Content | ConvertFrom-Json).changed_files
if ($filesno -le 100) {
$chunk = (Invoke-GithubRequest -Query "repos/$REPOSITORY/pulls/$ID/files?per_page=$filesno").Content | ConvertFrom-Json
$files += @($chunk)
} else {
for ($i = 1; $i -lt ($filesno / 100) + 1; $i++) {
$chunk = (Invoke-GithubRequest -Query "repos/$REPOSITORY/pulls/$ID/files?per_page=100&page=$i").Content | ConvertFrom-Json
$files += @($chunk)
}
}
if ($Filter) { $files = $files | Where-Object { $_.status -ne 'removed' } }
return $files | Select-Object -Property filename, status
}
function New-Issue {
<#
.SYNOPSIS
Create new issue in repository.
https://developer.github.com/v3/issues/#create-an-issue
.PARAMETER Title
The title of issue.
.PARAMETER Body
Description of Issue. Array will be joined with CRLF.
.PARAMETER Milestone
Number of milestone to be associated with issue.
Authenticated user needs push access to repository to be able to set milestone.
.PARAMETER Label
List of labels to be automatically added.
Authenticated user needs push access to repository to be able to set label.
.PARAMETER Assignee
List of user logins to be automatically assigned.
Authenticated user needs push access to repository to be able to set assignees.
#>
[CmdletBinding(SupportsShouldProcess)]
param(
[Parameter(Mandatory)]
[String] $Title,
[String[]] $Body = '',
[Int] $Milestone,
[String[]] $Label = @(),
[String[]] $Assignee = @()
)
if ($PSCmdlet.ShouldProcess("GitHub: $REPOSITORY", 'Create New Issue')) {
$params = @{
'title' = $Title
'body' = ($Body -join "`r`n")
'labels' = $Label
'assignees' = $Assignee
}
if ($Milestone) { $params.Add('milestone', $Milestone) }
$resp = Invoke-GithubRequest "repos/$REPOSITORY/issues" -Method 'Post' -Body $params
}
}
function Close-Issue {
<#
.SYNOPSIS
Close issue / PR.
https://developer.github.com/v3/issues/#edit-an-issue
.PARAMETER ID
ID of issue / PR to be closed.
#>
param([Parameter(Mandatory)][Int] $ID)
$resp = Invoke-GithubRequest -Query "repos/$REPOSITORY/issues/$ID" -Method Patch -Body @{ 'state' = 'closed' }
}
function Add-Label {
<#
.SYNOPSIS
Add label to issue / PR.
https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
.PARAMETER ID
Id of issue / PR.
.PARAMETER Label
Label to be set.
#>
param(
[Parameter(Mandatory)]
[Int] $ID,
[Parameter(Mandatory)]
[ValidateNotNullOrEmpty()] # > Must contains at least one label
[String[]] $Label
)
$resp = Invoke-GithubRequest -Query "repos/$REPOSITORY/issues/$ID/labels" -Method Post -Body @{ 'labels' = $Label }
}
function Remove-Label {
<#
.SYNOPSIS
Remove label from issue / PR.
https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
.PARAMETER ID
ID of issue / PR.
.PARAMETER Label
Label to be removed.
#>
[CmdletBinding(SupportsShouldProcess)]
param(
[Parameter(Mandatory)]
[Int] $ID,
[ValidateNotNullOrEmpty()]
[String[]] $Label
)
if ($PSCmdlet.ShouldProcess("GitHub: $REPOSITORY", "Remove Label(s) from Issue #$ID")) {
$responses = New-Array
# Get all labels on specific issue
$issueLabels = (Invoke-GithubRequest -Query "repos/$REPOSITORY/issues/$ID/labels" | Select-Object -ExpandProperty Content | ConvertFrom-Json).name
foreach ($lab in $Label) {
if ($issueLabels -contains $lab) {
# https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
Add-IntoArray $responses (Invoke-GithubRequest -Query "repos/$REPOSITORY/issues/$ID/labels/$lab" -Method Delete)
}
}
return $responses
}
}
function Get-RateLimit {
<#
.SYNOPSIS
Retrieves the current GitHub API rate limit status.
Returns the rate limit information as a deserialized JSON object.
.PARAMETER Core
If specified, returns only the core rate limit information.
#>
param(
[Switch] $Core
)
$rateLimit = $null
try {
$response = Invoke-GithubRequest -Query 'rate_limit'
$rateLimit = $response.Content | ConvertFrom-Json
} catch {
Write-LogInfo -Summary "Failed to retrieve rate limit information.`n Exception occurred: $($_.Exception.Message)"
}
if ($Core -and $rateLimit -and $rateLimit.resources -and $rateLimit.resources.core) {
$rateLimit = $rateLimit.resources.core
}
return $rateLimit
}
function Get-JobID {
<#
.SYNOPSIS
Gets the ID for the current GitHub Actions job.
Caches the result to avoid redundant API calls.
.PARAMETER UseCache
Whether to use the cached job ID if available.
.PARAMETER RetryCount
Number of times to retry fetching the job ID if the initial attempt fails. Default is 3.
.PARAMETER RetryDelaySeconds
Number of seconds to wait between retries when fetching the job ID. Default is 3.
#>
param(
[Parameter(Mandatory)]
[Switch] $UseCache,
[ValidateRange(1, 10)]
[Int] $RetryCount = 3,
[ValidateRange(1, 30)]
[Int] $RetryDelaySeconds = 3
)
if ($UseCache -and $script:JOB_ID) {
return $script:JOB_ID
}
$jobId = $null
for ($i = 0; $i -lt $RetryCount; ++$i) {
try {
$response = Invoke-GithubRequest -Query "repos/$REPOSITORY/actions/runs/$RUN_ID/jobs"
$jobs = ($response.Content | ConvertFrom-Json).jobs
$jobId = $jobs | Where-Object { $_.name -eq $JOB } | Select-Object -ExpandProperty id -First 1
if ($jobId) {
# Cache the job ID
$script:JOB_ID = $jobId
break
}
} catch {
Start-Sleep -Seconds $RetryDelaySeconds
}
}
return $jobId
}
function Get-LogURL {
<#
.SYNOPSIS
Gets the URL for the current GitHub Actions job log.
If the job ID cannot be retrieved, this command returns the URL for the workflow run instead.
.PARAMETER UseCache
Whether to use the cached job ID if available.
.PARAMETER RetryCount
Number of times to retry fetching the job ID if the initial attempt fails. Default is 3.
.PARAMETER RetryDelaySeconds
Number of seconds to wait between retries when fetching the job ID. Default is 3.
#>
param(
[Parameter(Mandatory)]
[Switch] $UseCache,
[ValidateRange(1, 10)]
[Int] $RetryCount = 3,
[ValidateRange(1, 30)]
[Int] $RetryDelaySeconds = 3
)
$logURL = "https://github.com/$REPOSITORY/actions/runs/$RUN_ID"
$job_id = Get-JobID -UseCache:$UseCache -RetryCount $RetryCount -RetryDelaySeconds $RetryDelaySeconds
if ($job_id) {
$logURL += "/job/$job_id"
}
Write-Verbose "Log URL: $logURL"
return $logURL
}
Export-ModuleMember -Function Invoke-GithubRequest, Add-Comment, Get-AllChangedFilesInPR, New-Issue, Close-Issue, `
Add-Label, Remove-Label, Get-RateLimit, Get-JobID, Get-LogURL
You can’t perform that action at this time.