PowerShell/Docs/pull-repos.md

105 lines
3.1 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*pull-repos.ps1*
================
2021-11-08 21:36:42 +01:00
2023-08-06 11:42:46 +02:00
This PowerShell script pulls updates into all Git repositories in a folder (including submodules).
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-11-08 21:36:42 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./pull-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-ParentDir <String>
Specifies the path to the parent folder
Required? false
Position? 1
Default value "$PWD"
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-11-08 21:36:42 +01:00
```powershell
PS> ./pull-repos C:\MyRepos
2023-08-06 11:42:46 +02:00
⏳ (1) Searching for Git executable... git version 2.41.0.windows.3
⏳ (2) Checking parent folder... 33 subfolders
⏳ (3/35) Pulling into 📂base256unicode...
...
2021-11-08 21:36:42 +01:00
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-11-08 21:36:42 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
2023-08-06 11:42:46 +02:00
Pulls updates into Git repos
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-08-06 11:42:46 +02:00
This PowerShell script pulls updates into all Git repositories in a folder (including submodules).
2022-11-17 20:02:26 +01:00
.PARAMETER ParentDir
Specifies the path to the parent folder
.EXAMPLE
PS> ./pull-repos C:\MyRepos
2023-08-06 11:42:46 +02:00
⏳ (1) Searching for Git executable... git version 2.41.0.windows.3
⏳ (2) Checking parent folder... 33 subfolders
⏳ (3/35) Pulling into 📂base256unicode...
...
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$ParentDir = "$PWD")
try {
$StopWatch = [system.diagnostics.stopwatch]::startNew()
2023-05-26 12:20:18 +02:00
Write-Host "⏳ (1) Searching for Git executable... " -NoNewline
2022-11-17 20:02:26 +01:00
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
2023-05-26 12:20:18 +02:00
Write-Host "⏳ (2) Checking parent folder... " -NoNewline
2022-11-17 20:02:26 +01:00
if (-not(Test-Path "$ParentDir" -pathType container)) { throw "Can't access folder: $ParentDir" }
$Folders = (Get-ChildItem "$ParentDir" -attributes Directory)
$NumFolders = $Folders.Count
2023-05-26 12:20:18 +02:00
$ParentDirName = (Get-Item "$ParentDir").Name
2023-08-06 11:42:46 +02:00
Write-Host "$NumFolders subfolders"
2022-11-17 20:02:26 +01:00
[int]$Step = 3
[int]$Failed = 0
foreach ($Folder in $Folders) {
$FolderName = (Get-Item "$Folder").Name
2023-05-26 12:20:18 +02:00
Write-Host "⏳ ($Step/$($NumFolders + 2)) Pulling into 📂$FolderName... " -NoNewline
2022-11-17 20:02:26 +01:00
& git -C "$Folder" pull --recurse-submodules --jobs=4
if ($lastExitCode -ne "0") { $Failed++; write-warning "'git pull' in 📂$FolderName failed" }
& git -C "$Folder" submodule update --init --recursive
if ($lastExitCode -ne "0") { throw "'git submodule update' in 📂$Folder failed with exit code $lastExitCode" }
$Step++
}
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
2023-08-06 11:42:46 +02:00
"✔️ Pulling updates into $NumFolders repositories under 📂$ParentDirName took $Elapsed sec ($Failed failed)"
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-08-06 21:36:33 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of pull-repos.ps1 as of 08/06/2023 21:36:16)*