-
Notifications
You must be signed in to change notification settings - Fork 0
/
GitHelper.psm1
1237 lines (1077 loc) · 41.3 KB
/
GitHelper.psm1
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
Set-StrictMode -Version Latest
if (Get-Module -Name 'GitHelper') {
return
}
if (-not (Test-Path -Path 'variable:\Global:AF4JMgitErrors')) {
${Global:AF4JMgitErrors} = $false
}
if (-not (Test-Path -Path 'Env:src')) {
${Env:src} = (Join-Path -Path ((Get-Item -Path ${Env:HOME}).PSDrive.Root) -ChildPath 'src')
}
function Get-DefaultBranch {
<#
.SYNOPSIS
Get the name of the default branch, typically "main" (or in older repositories "master").
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('head')]
PARAM()
BEGIN {
(git symbolic-ref --short refs/remotes/origin/HEAD) -ireplace 'origin/',''
}
}
function Initialize-Repository {
<#
.SYNOPSIS
Initialize the current repository with a default branch tracking origin's default branch and an untracked "develop" branch.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('Init-Repo')]
PARAM()
BEGIN {
$default = Get-DefaultBranch
git branch --track $default "origin/${default}"
git branch --no-track 'develop' $default
#git remote set-head 'origin' 'main' # fixes the remote having the wrong default branch
npm install --global-style
nuget restore -Recursive -NonInteractive
}
}
function Get-GitDir {
<#
.SYNOPSIS
Get the parent directory of the root of the current git repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
If the current location is in a git repository, the name of the parent folder; otherwise, $null.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('gitdir')]
[OutputType([string])]
PARAM()
BEGIN {
$gitStatus = (Get-GitStatus)
if (-not $gitStatus) {
return $null
}
# (Get-GitStatus).GitDir is a string like 'C:\src\AF4JM\.git'
# Split-Path -Parent strips off the trailing '\.git'
# Split-Path -Leaf gets whatever is after the last remaining '\'
Split-Path -Path (Split-Path -Path ($gitStatus.GitDir) -Parent) -Leaf
}
}
function Set-Repository {
<#
.SYNOPSIS
Set the current location to the root of the specified repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Set-Repo', 'repo')]
PARAM(
#repository to set current location to
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Repository must be specified')]
[Alias('RepositoryName', 'RepoName')]
[string]$Name,
#path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'Path')]
[Alias('PSPath')]
[string]$Path = $null,
#literal path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'LiteralPath')]
[string]$LiteralPath = $null
)
BEGIN {
$ThePath = ${Env:src}
switch ($PSCmdlet.ParameterSetName) {
'Path' {
if ($Path) {
$ThePath = $Path
}
Set-Location -Path (Join-Path -Path $ThePath -ChildPath $Name)
}
'LiteralPath' {
if ($LiteralPath) {
$ThePath = $LiteralPath
}
Set-Location -LiteralPath (Join-Path -Path $ThePath -ChildPath $Name)
}
}
}
}
function Update-All {
<#
.SYNOPSIS
Stage & commit all files, including new files.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('commit')]
PARAM(
#commit message
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Commit message must be specified')]
[string]$Message
)
BEGIN {
git add --all
git commit "--message=${Message}"
}
}
function Switch-GitBranch {
<#
.SYNOPSIS
Set the current location to the root of the specified repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('checkout')]
PARAM(
#name of the branch to checkout
[Parameter(Mandatory = $true, Position = 0, HelpMessage = 'Branch name must be specified')]
[Alias('BranchName')]
[string]$Name,
#passed to git checkout
[Parameter()]
[switch]$Force
)
BEGIN {
git checkout $(IIf { $Force } '--force' $null) $Name
}
}
function Add-TrackingBranch {
<#
.SYNOPSIS
Create a remote tracking branch in the current git repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('gittrack')]
PARAM(
#Name of the remote branch to track. Will also be used as the name of the local tracking branch.
[Parameter(Mandatory = $true, Position = 0, HelpMessage = 'Branch must be specified')]
[string]$Branch
)
BEGIN {
git branch --track $Branch "origin/${Branch}"
}
}
function Remove-Branch {
<#
.SYNOPSIS
Drop the specified local branch from the current git repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('gitdrop')]
PARAM(
#Name of the local branch to drop.
[Parameter(Mandatory = $true, Position = 0, HelpMessage = 'Branch must be specified')]
[string]$Branch
)
BEGIN {
if ($PSCmdlet.ShouldProcess($Branch, 'git branch -d')) {
git branch -d $Branch
}
}
}
function Publish-Develop {
<#
.SYNOPSIS
Rebase default branch on 'develop' and push default branch. (git push --tags 'origin' ':')
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('pushdev')]
PARAM()
BEGIN {
$gitStatus = Get-GitStatus -Verbose:$false
if (-not $gitStatus) {
throw 'Not a git repository!'
}
$default = Get-DefaultBranch
$branch = $gitStatus.Branch
if (-not ($branch -eq $default)) {
Switch-GitBranch -Name $default -Verbose:$false
}
git rebase 'develop' --stat
git push --tags 'origin' --progress ':'
if (-not ($branch -eq $default)) {
Switch-GitBranch -Name $branch -Verbose:$false
}
}
}
function Publish-DevelopAlt {
<#
.SYNOPSIS
Rebase 'development' on 'develop' and push 'development'. (git push --tags 'origin' ':')
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $false)]
[Alias('pushdeva')]
PARAM()
BEGIN {
$gitStatus = Get-GitStatus -Verbose:$false
if (-not $gitStatus) {
throw 'Not a git repository!'
}
$branch = $gitStatus.Branch
if (-not ($branch -eq 'development')) {
Switch-GitBranch -Name 'development' -Verbose:$false
}
git rebase 'develop' --stat
git push --tags 'origin' --progress ':'
if (-not ($branch -eq 'development')) {
Switch-GitBranch -Name $branch -Verbose:$false
}
}
}
function Update-Develop {
<#
.SYNOPSIS
Pull default branch and rebase 'develop'.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('pulldev')]
PARAM()
BEGIN {
$gitStatus = Get-GitStatus -Verbose:$false
if (-not $gitStatus) {
throw 'Not a git repository!'
}
if ($PSCmdlet.ShouldProcess('current repository')) {
$stashRef = (git stash create --include-untracked "work in progress (GitHelper)")
$default = Get-DefaultBranch
$branch = $gitStatus.Branch
if (-not ($branch -eq $default)) {
Switch-GitBranch -Name $default -Verbose:$false
}
Read-Repository
git rebase --stat
Switch-GitBranch -Name 'develop' -Verbose:$false
git rebase $default --stat
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name $branch -Verbose:$false
}
if (-not $stashRef) {
Write-Verbose -Message "No changes found to stash for branch `"${branch}`", skipping `"git stash apply`"."
} else {
git stash apply $stashRef
}
}
}
}
function Update-DevelopAlt {
<#
.SYNOPSIS
Pull 'development' and rebase 'develop'.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('pulldeva')]
PARAM()
BEGIN {
$gitStatus = Get-GitStatus -Verbose:$false
if (-not $gitStatus) {
throw 'Not a git repository!'
}
if ($PSCmdlet.ShouldProcess('current repository')) {
$stashRef = (git stash create --include-untracked "work in progress (GitHelper)")
$default = Get-DefaultBranch
$branch = $gitStatus.Branch
if (-not ($branch -eq $default)) {
Switch-GitBranch -Name $default -Verbose:$false
}
Read-Repository
git rebase --stat
Switch-GitBranch -Name 'development' -Verbose:$false
git rebase --stat
Switch-GitBranch -Name 'develop' -Verbose:$false
git rebase 'development' --stat
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name $branch -Verbose:$false
}
if (-not $stashRef) {
Write-Verbose -Message "No changes found to stash for branch `"${branch}`", skipping `"git stash apply`"."
} else {
git stash apply $stashRef
}
}
}
}
function Read-Repository {
<#
.SYNOPSIS
Fetch the current git repository.
.INPUTS
You cannot pipe input to this function.
.OUTPUTS
Nothing is output from this function.
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Read-Repo')]
[Alias('fetch')]
PARAM()
BEGIN {
$gitDir = (Get-GitDir)
if (($gitDir) -and $PSCmdlet.ShouldProcess($gitDir, 'git fetch --all --tags --prune')) {
git fetch --all --tags --prune --progress
}
}
}
function Update-Branch {
<#
.SYNOPSIS
Git checkout & rebase the current or specified branch.
.DESCRIPTION
Checks out the local tracking branch and rebases it on the origin branch of the same name, for each branch specified, assumes the current directory is in the git repository.
.INPUTS
The branch name.
.OUTPUTS
Pipeline input, if -PassThru is $true; otherwise this function does not generate any output.
.EXAMPLE
git for-each-ref refs/heads --format="%(refname:short)" --sort=-committerdate | Update-Branch
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
PARAM(
#string array of local tracking branches. If omitted rebases the current branch only
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Branch must be specified')]
[AllowEmptyCollection()]
[Alias('BranchName')]
[string[]]$Name = $null,
#Indicates whether the output of this function should be the function input or nothing.
[Parameter()]
[switch]$PassThru
)
BEGIN {
if (($null -eq $Name) -or ($Name.Length -le 0)) {
$Name = , ((Get-GitStatus).Branch)
}
if (${Global:AF4JMgitErrors}) {
${Local:ErrorView} = ${Global:ErrorView}
${Global:ErrorView} = 'CategoryView' # better display in alternate shells for git dumping status to stderr instead of stdout
}
}
PROCESS {
if (($Name) -and ($Name.Length -gt 0)) {
foreach ($refname in $Name) {
if ($PSCmdlet.ShouldProcess($refname, 'git checkout --force')) {
Switch-GitBranch -Name $refname -Force -Verbose:$false
}
$gitStatus = (Get-GitStatus)
if ((($gitStatus.AheadBy -gt 0) -or ($gitStatus.BehindBy -gt 0)) -and $PSCmdlet.ShouldProcess("origin/${refname}", 'git rebase')) {
git rebase --stat
}
}
}
if ($PassThru) {
$PSItem
}
}
END {
if (${Global:AF4JMgitErrors}) {
${Global:ErrorView} = ${Local:ErrorView}
}
}
}
function Update-Repository {
<#
.SYNOPSIS
Get latest on a specified git repository.
.DESCRIPTION
Get latest on a specified git repository, rebase all known remote tracking branches.
.INPUTS
The repository name.
.OUTPUTS
Pipeline input, if -PassThru is $true; otherwise this function does not generate any output.
.EXAMPLE
Update-Repository -Name 'myRepo'
.EXAMPLE
'myRepo1','myRepo2','myRepo3' | Update-Repo
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Update-Repo')]
PARAM(
#repositories to get latest on
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Repository must be specified')]
[AllowEmptyCollection()]
[Alias('RepositoryName', 'RepoName')]
[string[]]$Name,
#path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'Path')]
[Alias('PSPath')]
[string]$Path = $null,
#literal path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'LiteralPath')]
[string]$LiteralPath = $null,
#switch which when specified indicates that current changes should be reset instead of stashed before getting latest and popped when done
[Parameter()]
[Alias('r')]
[switch]$Reset,
#Indicates whether the output of this function should be the function input or nothing.
[Parameter()]
[switch]$PassThru
)
BEGIN {
$ThePath = ${Env:src}
switch ($PSCmdlet.ParameterSetName) {
'Path' {
if ($Path) {
$ThePath = $Path
}
}
'LiteralPath' {
if ($LiteralPath) {
$ThePath = $LiteralPath
}
}
}
Push-Location
if (${Global:AF4JMgitErrors}) {
${Local:ErrorView} = ${Global:ErrorView}
${Global:ErrorView} = 'CategoryView' # better display in alternate shells for git dumping status to stderr instead of stdout
}
}
PROCESS {
if (($Name) -and ($Name.Length -gt 0)) {
foreach ($r in $Name) {
Write-Verbose -Message "Getting latest for `"${name}`"."
switch ($PSCmdlet.ParameterSetName) {
'Path' {
Set-Location -Path (Join-Path -Path $ThePath -ChildPath $r)
}
'LiteralPath' {
Set-Location -LiteralPath (Join-Path -Path $ThePath -ChildPath $r)
}
}
$branch = (Get-GitStatus -Verbose:$false).Branch
if ((-not $Reset) -and $PSCmdlet.ShouldProcess("${r}/${branch}", 'git stash create --include-untracked')) {
$stashRef = (git stash create --include-untracked 'work in progress (GitHelper)')
}
# shouldn't have to pass Verbose, but if I don't it doesn't work
Read-Repository -Verbose:($VerbosePreference -ne [Management.Automation.ActionPreference]::SilentlyContinue)
# get all local branches, filter down to remote tracking branches, short name only, call Update-Branch
(git for-each-ref 'refs/heads' --format="%(refname:short)~%(upstream)" --sort="committerdate") |
Where-Object -FilterScript { $PSItem.split("~")[1].Length -gt 0 } |
ForEach-Object -Process { $PSItem.split('~')[0] } |
Update-Branch -Verbose:($VerbosePreference -ne [Management.Automation.ActionPreference]::SilentlyContinue)
if (((Get-GitStatus -Verbose:$false).Branch -ne $branch) -and $PSCmdlet.ShouldProcess($branch, 'git checkout --force')) {
Switch-GitBranch -Name $branch -Force -Verbose:$false
}
if ((-not $Reset) -and (-not $stashRef)) {
Write-Verbose -Message "No changes found to stash for `"${r}/${branch}`", skipping `"git stash apply`"."
} elseif ($stashRef -and $PSCmdlet.ShouldProcess($branch, "git stash apply ${stashRef}")) {
git stash apply $stashRef
}
}
}
if ($PassThru) {
$PSItem
}
}
END {
Pop-Location
if (${Global:AF4JMgitErrors}) {
${Global:ErrorView} = ${Local:ErrorView}
}
}
}
function Update-DevelopBranch {
<#
.SYNOPSIS
Sync 'develop' branch to default branch on a specified git repository.
.DESCRIPTION
Intended to be run immediately after Read-Repository. Read-Repository updates any and all tracking branches, this function rebases "develop" on default branch.
.INPUTS
The repository name.
.OUTPUTS
Pipeline input, if -PassThru is $true; otherwise this function does not generate any output.
.EXAMPLE
Update-DevelopBranch -Name 'myRepo'
.EXAMPLE
'myRepo1','myRepo2','myRepo3' | Update-Dev
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Update-Dev')]
PARAM(
#repositories to get latest on
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Repository must be specified')]
[AllowEmptyCollection()]
[Alias('RepositoryName', 'RepoName')]
[string[]]$Name,
#path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'Path')]
[Alias('PSPath')]
[string]$Path = $null,
#literal path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'LiteralPath')]
[string]$LiteralPath = $null,
#switch which when specified indicates that current changes should be reset instead of stashed before getting latest and popped when done
[Parameter()]
[Alias('r')]
[switch]$Reset,
#Indicates whether the output of this function should be the function input or nothing.
[Parameter()]
[switch]$PassThru
)
BEGIN {
$ThePath = ${Env:src}
switch ($PSCmdlet.ParameterSetName) {
'Path' {
if ($Path) {
$ThePath = $Path
}
}
'LiteralPath' {
if ($LiteralPath) {
$ThePath = $LiteralPath
}
}
}
Push-Location
if (${Global:AF4JMgitErrors}) {
${Local:ErrorView} = ${Global:ErrorView}
${Global:ErrorView} = 'CategoryView' # better display in alternate shells for git dumping status to stderr instead of stdout
}
}
PROCESS {
if (($Name) -and ($Name.Length -gt 0)) {
foreach ($r in $Name) {
switch ($PSCmdlet.ParameterSetName) {
'Path' {
Set-Location -Path (Join-Path -Path $ThePath -ChildPath $r)
}
'LiteralPath' {
Set-Location -LiteralPath (Join-Path -Path $ThePath -ChildPath $r)
}
}
$default = Get-DefaultBranch
$branch = (Get-GitStatus -Verbose:$false).Branch
if ((-not $Reset) -and $PSCmdlet.ShouldProcess("${r}/${branch}", 'git stash create --include-untracked')) {
$stashRef = (git stash create --include-untracked "work in progress (GitHelper)")
}
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name 'develop' -Verbose:$false
}
git rebase $default --stat
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name $branch -Verbose:$false
}
if ((-not $Reset) -and (-not $stashRef)) {
Write-Verbose -Message "No changes found to stash for `"${r}/${branch}`", skipping `"git stash apply`"."
} elseif ($stashRef -and $PSCmdlet.ShouldProcess($branch, "git stash apply ${stashRef}")) {
git stash apply $stashRef
}
}
}
if ($PassThru) {
$PSItem
}
}
END {
Pop-Location
if (${Global:AF4JMgitErrors}) {
${Global:ErrorView} = ${Local:ErrorView}
}
}
}
function Update-DevelopBranchAlt {
<#
.SYNOPSIS
Sync 'develop' branch to 'development' branch on a specified git repository.
.DESCRIPTION
Intended to be run immediately after Read-Repository. Read-Repository updates any and all tracking branches, this function rebases "develop" on "development".
.INPUTS
The repository name.
.OUTPUTS
Pipeline input, if -PassThru is $true; otherwise this function does not generate any output.
.EXAMPLE
Update-DevelopBranchAlt -Name 'myRepo'
.EXAMPLE
'myRepo1','myRepo2','myRepo3' | Update-DevAlt
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Update-DevAlt')]
PARAM(
#repositories to get latest on
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Repository must be specified')]
[AllowEmptyCollection()]
[Alias('RepositoryName', 'RepoName')]
[string[]]$Name,
#path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'Path')]
[Alias('PSPath')]
[string]$Path = $null,
#literal path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'LiteralPath')]
[string]$LiteralPath = $null,
#switch which when specified indicates that current changes should be reset instead of stashed before getting latest and popped when done
[Parameter()]
[Alias('r')]
[switch]$Reset,
#Indicates whether the output of this function should be the function input or nothing.
[Parameter()]
[switch]$PassThru
)
BEGIN {
$ThePath = ${Env:src}
switch ($PSCmdlet.ParameterSetName) {
'Path' {
if ($Path) {
$ThePath = $Path
}
}
'LiteralPath' {
if ($LiteralPath) {
$ThePath = $LiteralPath
}
}
}
Push-Location
if (${Global:AF4JMgitErrors}) {
${Local:ErrorView} = ${Global:ErrorView}
${Global:ErrorView} = 'CategoryView' # better display in alternate shells for git dumping status to stderr instead of stdout
}
}
PROCESS {
if (($Name) -and ($Name.Length -gt 0)) {
foreach ($r in $Name) {
switch ($PSCmdlet.ParameterSetName) {
'Path' {
Set-Location -Path (Join-Path -Path $ThePath -ChildPath $r)
}
'LiteralPath' {
Set-Location -LiteralPath (Join-Path -Path $ThePath -ChildPath $r)
}
}
$branch = (Get-GitStatus -Verbose:$false).Branch
if ((-not $Reset) -and $PSCmdlet.ShouldProcess("${r}/${branch}", 'git stash create --include-untracked')) {
$stashRef = (git stash create --include-untracked "work in progress (GitHelper)")
}
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name 'develop' -Verbose:$false
}
git rebase 'development' --stat
if (-not ($branch -eq 'develop')) {
Switch-GitBranch -Name $branch -Verbose:$false
}
if ((-not $Reset) -and (-not $stashRef)) {
Write-Verbose -Message "No changes found to stash for `"${r}/${branch}`", skipping `"git stash apply`"."
} elseif ($stashRef -and $PSCmdlet.ShouldProcess($branch, "git stash apply ${stashRef}")) {
git stash apply $stashRef
}
}
}
if ($PassThru) {
$PSItem
}
}
END {
Pop-Location
if (${Global:AF4JMgitErrors}) {
${Global:ErrorView} = ${Local:ErrorView}
}
}
}
function Optimize-Repository {
<#
.SYNOPSIS
Optimize a specified git repository.
.DESCRIPTION
Runs "git gc --aggressive" on the specified repository.
.INPUTS
The repository name.
.OUTPUTS
Pipeline input, if -PassThru is $true; otherwise this function does not generate any output.
.EXAMPLE
Optimize-Repository -Name 'myRepo'
.EXAMPLE
'myRepo1','myRepo2','myRepo3' | Optimize-Repo
.NOTES
Author: John Meyer, AF4JM
Copyright © 2017-2023 John Meyer, AF4JM. Licensed under the MIT License. https://github.com/af4jm/GitHelper/blob/main/LICENSE
.LINK
https://www.powershellgallery.com/packages/GitHelper/
.LINK
https://github.com/af4jm/GitHelper/
#>
[CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Path', PositionalBinding = $true, SupportsPaging = $false, SupportsShouldProcess = $true)]
[Alias('Optimize-Repo')]
PARAM(
#repositories to get latest on
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromRemainingArguments = $true, Position = 0, HelpMessage = 'Repository must be specified')]
[AllowEmptyCollection()]
[Alias('RepositoryName', 'RepoName')]
[string[]]$Name,
#path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'Path')]
[Alias('PSPath')]
[string]$Path = $null,
#literal path to repositories folder, ${Env:src} if not specified
[Parameter(ParameterSetName = 'LiteralPath')]
[string]$LiteralPath = $null,
#Indicates whether the output of this function should be the function input or nothing.
[Parameter()]