PowerShell/docs/fetch-repos.md

102 lines
3.1 KiB
Markdown
Raw Normal View History

2024-11-08 12:38:20 +01:00
The *fetch-repos.ps1* Script
===========================
2021-11-08 21:36:42 +01:00
2023-08-06 11:42:46 +02:00
This PowerShell script fetches 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
2024-11-08 12:35:11 +01:00
/home/markus/Repos/PowerShell/scripts/fetch-repos.ps1 [[-parentDirPath] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-09-20 17:05:11 +02:00
-parentDirPath <String>
2023-10-19 08:12:00 +02:00
Specifies the path to the parent folder
2021-11-08 21:36:42 +01:00
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
2023-08-06 21:36:33 +02:00
PS> ./fetch-repos.ps1 C:\MyRepos
2024-11-08 12:35:11 +01:00
⏳ (1) Searching for Git executable... git version 2.46.0.windows.1
2023-10-19 08:12:00 +02:00
⏳ (2) Checking parent folder... 33 subfolders
2024-11-08 12:35:11 +01:00
⏳ (3/35) Fetching into 📂curl...
2023-08-06 11:42:46 +02:00
...
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
Fetches updates into Git repos
2022-11-17 20:02:26 +01:00
.DESCRIPTION
2023-08-06 11:42:46 +02:00
This PowerShell script fetches updates into all Git repositories in a folder (including submodules).
2023-10-19 08:12:00 +02:00
.PARAMETER parentDirPath
2022-11-17 20:02:26 +01:00
Specifies the path to the parent folder
.EXAMPLE
2023-08-06 21:36:33 +02:00
PS> ./fetch-repos.ps1 C:\MyRepos
2024-11-08 12:35:11 +01:00
⏳ (1) Searching for Git executable... git version 2.46.0.windows.1
2023-10-19 08:12:00 +02:00
⏳ (2) Checking parent folder... 33 subfolders
2024-11-08 12:35:11 +01:00
⏳ (3/35) Fetching into 📂curl...
2023-08-06 11:42:46 +02:00
...
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-09-20 17:05:11 +02:00
param([string]$parentDirPath = "$PWD")
2022-11-17 20:02:26 +01:00
try {
2023-09-20 17:05:11 +02:00
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2022-11-17 20:02:26 +01:00
2023-09-20 17:05:11 +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-09-20 17:05:11 +02:00
Write-Host "⏳ (2) Checking parent folder... " -noNewline
if (-not(Test-Path "$parentDirPath" -pathType container)) { throw "Can't access folder: $parentDirPath" }
$folders = (Get-ChildItem "$parentDirPath" -attributes Directory)
$numFolders = $folders.Count
$parentDirPathName = (Get-Item "$parentDirPath").Name
Write-Host "$numFolders subfolders"
[int]$step = 3
foreach ($folder in $folders) {
$folderName = (Get-Item "$folder").Name
2023-10-19 08:12:00 +02:00
Write-Host "⏳ ($step/$($numFolders + 2)) Fetching into 📂$folderName...`t`t"
2023-09-20 17:05:11 +02:00
& git -C "$folder" fetch --all --recurse-submodules --prune --prune-tags --force
2024-11-08 12:35:11 +01:00
if ($lastExitCode -ne "0") { throw "'git fetch --all' in 📂$folder failed with exit code $lastExitCode" }
2023-09-20 17:05:11 +02:00
$step++
2022-11-17 20:02:26 +01:00
}
2023-09-20 17:05:11 +02:00
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
2024-11-08 12:35:11 +01:00
"✅ Fetched into $numFolders repos under 📂$parentDirPathName in $($elapsed)s."
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
2024-11-08 12:38:20 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of fetch-repos.ps1 as of 11/08/2024 12:37:51)*