-
Notifications
You must be signed in to change notification settings - Fork 187
/
GitHubReleases.ps1
1460 lines (1173 loc) · 44.9 KB
/
GitHubReleases.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
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
@{
GitHubReleaseTypeName = 'GitHub.Release'
GitHubReleaseAssetTypeName = 'GitHub.ReleaseAsset'
}.GetEnumerator() | ForEach-Object {
Set-Variable -Scope Script -Option ReadOnly -Name $_.Key -Value $_.Value
}
filter Get-GitHubRelease
{
<#
.SYNOPSIS
Retrieves information about a release or list of releases on GitHub.
.DESCRIPTION
Retrieves information about a release or list of releases on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Release
The ID of a specific release.
This is an optional parameter which can limit the results to a single release.
.PARAMETER Latest
Retrieve only the latest release.
This is an optional parameter which can limit the results to a single release.
.PARAMETER Tag
Retrieves a list of releases with the associated tag.
This is an optional parameter which can filter the list of releases.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Reaction
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.OUTPUTS
GitHub.Release
.EXAMPLE
Get-GitHubRelease
Gets all releases for the default configured owner/repository.
.EXAMPLE
Get-GitHubRelease -Release 12345
Get a specific release for the default configured owner/repository
.EXAMPLE
Get-GitHubRelease -OwnerName dotnet -RepositoryName core
Gets all releases from the dotnet\core repository.
.EXAMPLE
Get-GitHubRelease -Uri https://github.com/microsoft/PowerShellForGitHub
Gets all releases from the microsoft/PowerShellForGitHub repository.
.EXAMPLE
Get-GitHubRelease -OwnerName dotnet -RepositoryName core -Latest
Gets the latest release from the dotnet\core repository.
.EXAMPLE
Get-GitHubRelease -Uri https://github.com/microsoft/PowerShellForGitHub -Tag 0.8.0
Gets the release tagged with 0.8.0 from the microsoft/PowerShellForGitHub repository.
.NOTES
Information about published releases are available to everyone. Only users with push
access will receive listings for draft releases.
#>
[CmdletBinding(DefaultParameterSetName='Elements')]
[OutputType({$script:GitHubReleaseTypeName})]
param(
[Parameter(ParameterSetName='Elements')]
[Parameter(ParameterSetName="Elements-ReleaseId")]
[Parameter(ParameterSetName="Elements-Latest")]
[Parameter(ParameterSetName="Elements-Tag")]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements')]
[Parameter(ParameterSetName="Elements-ReleaseId")]
[Parameter(ParameterSetName="Elements-Latest")]
[Parameter(ParameterSetName="Elements-Tag")]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri')]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName="Uri-ReleaseId")]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName="Uri-Latest")]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName="Uri-Tag")]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName="Elements-ReleaseId")]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName="Uri-ReleaseId")]
[Alias('ReleaseId')]
[int64] $Release,
[Parameter(
Mandatory,
ParameterSetName='Elements-Latest')]
[Parameter(
Mandatory,
ParameterSetName='Uri-Latest')]
[switch] $Latest,
[Parameter(
Mandatory,
ParameterSetName='Elements-Tag')]
[Parameter(
Mandatory,
ParameterSetName='Uri-Tag')]
[string] $Tag,
[string] $AccessToken
)
Write-InvocationLog
$elements = Resolve-RepositoryElements
$OwnerName = $elements.ownerName
$RepositoryName = $elements.repositoryName
$telemetryProperties = @{
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
}
$uriFragment = "repos/$OwnerName/$RepositoryName/releases"
$description = "Getting releases for $OwnerName/$RepositoryName"
if ($PSBoundParameters.ContainsKey('Release'))
{
$telemetryProperties['ProvidedRelease'] = $true
$uriFragment += "/$Release"
$description = "Getting release information for $Release from $OwnerName/$RepositoryName"
}
if ($Latest)
{
$telemetryProperties['GetLatest'] = $true
$uriFragment += "/latest"
$description = "Getting latest release from $OwnerName/$RepositoryName"
}
if (-not [String]::IsNullOrEmpty($Tag))
{
$telemetryProperties['ProvidedTag'] = $true
$uriFragment += "/tags/$Tag"
$description = "Getting releases tagged with $Tag from $OwnerName/$RepositoryName"
}
$params = @{
'UriFragment' = $uriFragment
'Description' = $description
'AccessToken' = $AccessToken
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
}
return (Invoke-GHRestMethodMultipleResult @params | Add-GitHubReleaseAdditionalProperties)
}
filter New-GitHubRelease
{
<#
.SYNOPSIS
Create a new release for a repository on GitHub.
.DESCRIPTION
Create a new release for a repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Tag
The name of the tag. The tag will be created around the committish if it doesn't exist
in the remote, and will need to be synced back to the local repository afterwards.
.PARAMETER Committish
The committish value that determines where the Git tag is created from.
Can be any branch or commit SHA. Unused if the Git tag already exists.
Will default to the repository's default branch (usually 'master').
.PARAMETER Name
The name of the release.
.PARAMETER Body
Text describing the contents of the tag.
.PARAMETER Draft
Specifies if this should be a draft (unpublished) release or a published one.
.PARAMETER PreRelease
Indicates if this should be identified as a pre-release or as a full release.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.OUTPUTS
GitHub.Release
.EXAMPLE
New-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Tag 0.12.0
.NOTES
Requires push access to the repository.
This endpoind triggers notifications. Creating content too quickly using this endpoint
may result in abuse rate limiting.
#>
[CmdletBinding(
SupportsShouldProcess,
PositionalBinding = $false)]
[OutputType({$script:GitHubReleaseTypeName})]
param(
[Parameter(ParameterSetName='Elements')]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements')]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri',
Position = 1)]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
Position = 2)]
[string] $Tag,
[Alias('Sha')]
[Alias('BranchName')]
[Alias('Commitish')] # git documentation says "committish", but GitHub uses "commitish"
[string] $Committish,
[string] $Name,
[Alias('Description')]
[string] $Body,
[switch] $Draft,
[switch] $PreRelease,
[string] $AccessToken
)
Write-InvocationLog
$elements = Resolve-RepositoryElements
$OwnerName = $elements.ownerName
$RepositoryName = $elements.repositoryName
$telemetryProperties = @{
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
'ProvidedCommittish' = ($PSBoundParameters.ContainsKey('Committish'))
'ProvidedName' = ($PSBoundParameters.ContainsKey('Name'))
'ProvidedBody' = ($PSBoundParameters.ContainsKey('Body'))
'ProvidedDraft' = ($PSBoundParameters.ContainsKey('Draft'))
'ProvidedPreRelease' = ($PSBoundParameters.ContainsKey('PreRelease'))
}
$hashBody = @{
'tag_name' = $Tag
}
if ($PSBoundParameters.ContainsKey('Committish')) { $hashBody['target_commitish'] = $Committish }
if ($PSBoundParameters.ContainsKey('Name')) { $hashBody['name'] = $Name }
if ($PSBoundParameters.ContainsKey('Body')) { $hashBody['body'] = $Body }
if ($PSBoundParameters.ContainsKey('Draft')) { $hashBody['draft'] = $Draft.ToBool() }
if ($PSBoundParameters.ContainsKey('PreRelease')) { $hashBody['prerelease'] = $PreRelease.ToBool() }
$params = @{
'UriFragment' = "/repos/$OwnerName/$RepositoryName/releases"
'Body' = (ConvertTo-Json -InputObject $hashBody)
'Method' = 'Post'
'Description' = "Creating release at $Tag"
'AccessToken' = $AccessToken
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
}
if (-not $PSCmdlet.ShouldProcess($Tag, "Create release for $RepositoryName at tag"))
{
return
}
return (Invoke-GHRestMethod @params | Add-GitHubReleaseAdditionalProperties)
}
filter Set-GitHubRelease
{
<#
.SYNOPSIS
Edits a release for a repository on GitHub.
.DESCRIPTION
Edits a release for a repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Release
The ID of the release to edit.
.PARAMETER Tag
The name of the tag.
.PARAMETER Committish
The committish value that determines where the Git tag is created from.
Can be any branch or commit SHA. Unused if the Git tag already exists.
Will default to the repository's default branch (usually 'master').
.PARAMETER Name
The name of the release.
.PARAMETER Body
Text describing the contents of the tag.
.PARAMETER Draft
Specifies if this should be a draft (unpublished) release or a published one.
.PARAMETER PreRelease
Indicates if this should be identified as a pre-release or as a full release.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.OUTPUTS
GitHub.Release
.EXAMPLE
Set-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Tag 0.12.0 -Body 'Adds core support for Projects'
.NOTES
Requires push access to the repository.
#>
[CmdletBinding(
SupportsShouldProcess,
PositionalBinding = $false)]
[OutputType({$script:GitHubReleaseTypeName})]
param(
[Parameter(ParameterSetName='Elements')]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements')]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri',
Position = 1)]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
Position = 2)]
[Alias('ReleaseId')]
[int64] $Release,
[string] $Tag,
[Alias('Sha')]
[Alias('BranchName')]
[Alias('Commitish')] # git documentation says "committish", but GitHub uses "commitish"
[string] $Committish,
[string] $Name,
[Alias('Description')]
[string] $Body,
[switch] $Draft,
[switch] $PreRelease,
[string] $AccessToken
)
Write-InvocationLog
$elements = Resolve-RepositoryElements
$OwnerName = $elements.ownerName
$RepositoryName = $elements.repositoryName
$telemetryProperties = @{
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
'ProvidedTag' = ($PSBoundParameters.ContainsKey('Tag'))
'ProvidedCommittish' = ($PSBoundParameters.ContainsKey('Committish'))
'ProvidedName' = ($PSBoundParameters.ContainsKey('Name'))
'ProvidedBody' = ($PSBoundParameters.ContainsKey('Body'))
'ProvidedDraft' = ($PSBoundParameters.ContainsKey('Draft'))
'ProvidedPreRelease' = ($PSBoundParameters.ContainsKey('PreRelease'))
}
$hashBody = @{}
if ($PSBoundParameters.ContainsKey('Tag')) { $hashBody['tag_name'] = $Tag }
if ($PSBoundParameters.ContainsKey('Committish')) { $hashBody['target_commitish'] = $Committish }
if ($PSBoundParameters.ContainsKey('Name')) { $hashBody['name'] = $Name }
if ($PSBoundParameters.ContainsKey('Body')) { $hashBody['body'] = $Body }
if ($PSBoundParameters.ContainsKey('Draft')) { $hashBody['draft'] = $Draft.ToBool() }
if ($PSBoundParameters.ContainsKey('PreRelease')) { $hashBody['prerelease'] = $PreRelease.ToBool() }
$params = @{
'UriFragment' = "/repos/$OwnerName/$RepositoryName/releases/$Release"
'Body' = (ConvertTo-Json -InputObject $hashBody)
'Method' = 'Patch'
'Description' = "Creating release at $Tag"
'AccessToken' = $AccessToken
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
}
if (-not $PSCmdlet.ShouldProcess($Release, "Update GitHub Release"))
{
return
}
return (Invoke-GHRestMethod @params | Add-GitHubReleaseAdditionalProperties)
}
filter Remove-GitHubRelease
{
<#
.SYNOPSIS
Removes a release from a repository on GitHub.
.DESCRIPTION
Removes a release from a repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Release
The ID of the release to remove.
.PARAMETER Force
If this switch is specified, you will not be prompted for confirmation of command execution.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.EXAMPLE
Remove-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Release 1234567890
.EXAMPLE
Remove-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Release 1234567890 -Confirm:$false
Will not prompt for confirmation, as -Confirm:$false was specified.
.NOTES
Requires push access to the repository.
#>
[CmdletBinding(
SupportsShouldProcess,
PositionalBinding = $false,
ConfirmImpact='High')]
[Alias('Delete-GitHubRelease')]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="The Uri parameter is only referenced by Resolve-RepositoryElements which get access to it from the stack via Get-Variable -Scope 1.")]
param(
[Parameter(ParameterSetName='Elements')]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements')]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri',
Position = 1)]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
Position = 2)]
[Alias('ReleaseId')]
[int64] $Release,
[switch] $Force,
[string] $AccessToken
)
Write-InvocationLog
$elements = Resolve-RepositoryElements
$OwnerName = $elements.ownerName
$RepositoryName = $elements.repositoryName
$telemetryProperties = @{
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
}
$params = @{
'UriFragment' = "/repos/$OwnerName/$RepositoryName/releases/$Release"
'Method' = 'Delete'
'Description' = "Deleting release $Release"
'AccessToken' = $AccessToken
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
}
if ($Force -and (-not $Confirm))
{
$ConfirmPreference = 'None'
}
if (-not $PSCmdlet.ShouldProcess($Release, "Remove GitHub Release"))
{
return
}
return Invoke-GHRestMethod @params
}
filter Get-GitHubReleaseAsset
{
<#
.SYNOPSIS
Gets a a list of assets for a release, or downloads a single release asset.
.DESCRIPTION
Gets a a list of assets for a release, or downloads a single release asset.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Release
The ID of a specific release to see the assets for.
.PARAMETER Asset
The ID of the specific asset to download.
.PARAMETER Path
The path where the downloaded asset should be stored.
.PARAMETER Force
If specified, will overwrite any file located at Path when downloading Asset.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.OUTPUTS
GitHub.ReleaseAsset
.EXAMPLE
Get-GitHubReleaseAsset -OwnerName microsoft -RepositoryName PowerShellForGitHub -Release 1234567890
Gets a list of all the assets associated with this release
.EXAMPLE
Get-GitHubReleaseAsset -OwnerName microsoft -RepositoryName PowerShellForGitHub -Asset 1234567890 -Path 'c:\users\PowerShellForGitHub\downloads\asset.zip' -Force
Downloads the asset 1234567890 to 'c:\users\PowerShellForGitHub\downloads\asset.zip' and
overwrites the file that may already be there.
#>
[CmdletBinding(PositionalBinding = $false)]
[OutputType({$script:GitHubReleaseAssetTypeName})]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="The Uri parameter is only referenced by Resolve-RepositoryElements which get access to it from the stack via Get-Variable -Scope 1.")]
param(
[Parameter(ParameterSetName='Elements-List')]
[Parameter(ParameterSetName='Elements-Info')]
[Parameter(ParameterSetName='Elements-Download')]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements-List')]
[Parameter(ParameterSetName='Elements-Info')]
[Parameter(ParameterSetName='Elements-Download')]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-Info',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-Download',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-List',
Position = 1)]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Elements-List',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-List',
Position = 2)]
[Alias('ReleaseId')]
[int64] $Release,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Elements-Info',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Elements-Download',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-Info',
Position = 2)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri-Download',
Position = 2)]
[Alias('AssetId')]
[int64] $Asset,
[Parameter(
Mandatory,
ParameterSetName='Elements-Download',
Position = 2)]
[Parameter(
Mandatory,
ParameterSetName='Uri-Download',
Position = 3)]
[string] $Path,
[Parameter(ParameterSetName='Elements-Download')]
[Parameter(ParameterSetName='Uri-Download')]
[switch] $Force,
[string] $AccessToken
)
Write-InvocationLog
$elements = Resolve-RepositoryElements
$OwnerName = $elements.ownerName
$RepositoryName = $elements.repositoryName
$telemetryProperties = @{
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
}
$uriFragment = [String]::Empty
$description = [String]::Empty
$shouldSave = $false
$acceptHeader = $script:defaultAcceptHeader
if ($PSCmdlet.ParameterSetName -in ('Elements-List', 'Uri-List'))
{
$uriFragment = "/repos/$OwnerName/$RepositoryName/releases/$Release/assets"
$description = "Getting list of assets for release $Release"
}
elseif ($PSCmdlet.ParameterSetName -in ('Elements-Info', 'Uri-Info'))
{
$uriFragment = "/repos/$OwnerName/$RepositoryName/releases/assets/$Asset"
$description = "Getting information about release asset $Asset"
}
elseif ($PSCmdlet.ParameterSetName -in ('Elements-Download', 'Uri-Download'))
{
$uriFragment = "/repos/$OwnerName/$RepositoryName/releases/assets/$Asset"
$description = "Downloading release asset $Asset"
$shouldSave = $true
$acceptHeader = 'application/octet-stream'
$Path = Resolve-UnverifiedPath -Path $Path
}
$params = @{
'UriFragment' = $uriFragment
'Method' = 'Get'
'Description' = $description
'AcceptHeader' = $acceptHeader
'Save' = $shouldSave
'AccessToken' = $AccessToken
'TelemetryEventName' = $MyInvocation.MyCommand.Name
'TelemetryProperties' = $telemetryProperties
}
$result = Invoke-GHRestMethod @params
if ($PSCmdlet.ParameterSetName -in ('Elements-Download', 'Uri-Download'))
{
Write-Log -Message "Moving [$($result.FullName)] to [$Path]" -Level Verbose
return (Move-Item -Path $result -Destination $Path -Force:$Force -ErrorAction Stop -PassThru)
}
else
{
return ($result | Add-GitHubReleaseAssetAdditionalProperties)
}
}
filter New-GitHubReleaseAsset
{
<#
.SYNOPSIS
Uploads a new asset for a release on GitHub.
.DESCRIPTION
Uploads a new asset for a release on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
.PARAMETER OwnerName
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
.PARAMETER RepositoryName
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
.PARAMETER Uri
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
.PARAMETER Release
The ID of the release that the asset is for.
.PARAMETER UploadUrl
The value of 'upload_url' from getting the asset details.
.PARAMETER Path
The path to the file to upload as a new asset.
.PARAMETER Label
An alternate short description of the asset. Used in place of the filename.
.PARAMETER ContentType
The MIME Media Type for the file being uploaded. By default, this will be inferred based
on the file's extension. If the extension is not known by this module, it will fallback to
using text/plain. You may specify a ContentType here to override the module's logic.
.PARAMETER AccessToken
If provided, this will be used as the AccessToken for authentication with the
REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.
.INPUTS
GitHub.Branch
GitHub.Content
GitHub.Event
GitHub.Issue
GitHub.IssueComment
GitHub.Label
GitHub.Milestone
GitHub.PullRequest
GitHub.Project
GitHub.ProjectCard
GitHub.ProjectColumn
GitHub.Release
GitHub.ReleaseAsset
GitHub.Repository
.OUTPUTS
GitHub.ReleaseAsset
.EXAMPLE
New-GitHubReleaseAsset -OwnerName microsoft -RepositoryName PowerShellForGitHub -Release 123456 -Path 'c:\foo.zip'
Uploads the file located at 'c:\foo.zip' to the 123456 release in microsoft/PowerShellForGitHub
.EXAMPLE
$release = New-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Tag 'stable'
$release | New-GitHubReleaseAsset -Path 'c:\bar.txt'
Creates a new release tagged as 'stable' and then uploads 'c:\bar.txt' as an asset for
that release.
.NOTES
GitHub renames asset filenames that have special characters, non-alphanumeric characters,
and leading or trailing periods. Get-GitHubReleaseAsset lists the renamed filenames.
If you upload an asset with the same filename as another uploaded asset, you'll receive
an error and must delete the old file before you can re-upload the new asset.
#>
[CmdletBinding(
SupportsShouldProcess,
PositionalBinding = $false)]
[OutputType({$script:GitHubReleaseAssetTypeName})]
param(
[Parameter(ParameterSetName='Elements')]
[string] $OwnerName,
[Parameter(ParameterSetName='Elements')]
[string] $RepositoryName,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri',
Position = 1)]
[Parameter(
ValueFromPipelineByPropertyName,
ParameterSetName='UploadUrl')]
[Alias('RepositoryUrl')]
[string] $Uri,
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Elements',
Position = 1)]
[Parameter(
Mandatory,
ValueFromPipelineByPropertyName,
ParameterSetName='Uri',
Position = 2)]
[Parameter(