PowerShell/docs/fetch-repo.md
2024-05-19 10:25:56 +02:00

93 lines
2.8 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Script: *fetch-repo.ps1*
========================
This PowerShell script fetches the latest updates into a local Git repository (including submodules).
Parameters
----------
```powershell
PS> ./fetch-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the file path to the local Git repository (default is working directory).
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.
```
Example
-------
```powershell
PS> ./fetch-repo.ps1 C:\MyRepo
(1/3) Searching for Git executable... git version 2.41.0.windows.3
(2/3) Checking local repository...
(3/3) Fetching updates...
Fetched updates into repo 📂MyRepo (took 2 sec)
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Fetches Git repository updates
.DESCRIPTION
This PowerShell script fetches the latest updates into a local Git repository (including submodules).
.PARAMETER RepoDir
Specifies the file path to the local Git repository (default is working directory).
.EXAMPLE
PS> ./fetch-repo.ps1 C:\MyRepo
⏳ (1/3) Searching for Git executable... git version 2.41.0.windows.3
⏳ (2/3) Checking local repository...
⏳ (3/3) Fetching updates...
✔️ Fetched updates into repo 📂MyRepo (took 2 sec)
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$RepoDir = "$PWD")
try {
$StopWatch = [system.diagnostics.stopwatch]::startNew()
Write-Host "⏳ (1/3) Searching for Git executable... " -noNewline
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
Write-Host "⏳ (2/3) Checking local repository..."
if (!(Test-Path "$RepoDir" -pathType container)) { throw "Can't access folder: $RepoDir" }
$RepoDirName = (Get-Item "$RepoDir").Name
Write-Host "⏳ (3/3) Fetching updates..."
& git -C "$RepoDir" fetch --all --recurse-submodules --tags --prune --prune-tags --force --quiet
if ($lastExitCode -ne "0") { throw "'git fetch --all' failed with exit code $lastExitCode" }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ Fetched updates into repo 📂$RepoDirName (took $Elapsed sec)"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of fetch-repo.ps1 as of 05/19/2024 10:25:20)*