PowerShell/Docs/fetch-repo.md
2022-12-04 10:40:18 +01:00

87 lines
2.7 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.

## The *fetch-repo.ps1* Script
This PowerShell script fetches updates for a local Git repository (including submodules).
## Parameters
```powershell
fetch-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the path to the Git repository.
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
(1/3) Searching for Git executable... git version 2.38.1.windows.1
(2/3) Checking Git repository 📂PowerShell...
(3/3) Fetching updates (including submodules)...
fetched updates for Git repository 📂PowerShell in 2 sec.
```
## Notes
Author: Markus Fleschutz | License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
## Source Code
```powershell
<#
.SYNOPSIS
Fetches updates for a Git repo
.DESCRIPTION
This PowerShell script fetches updates for a local Git repository (including submodules).
.PARAMETER RepoDir
Specifies the path to the Git repository.
.EXAMPLE
PS> ./fetch-repo
⏳ (1/3) Searching for Git executable... git version 2.38.1.windows.1
⏳ (2/3) Checking Git repository 📂PowerShell...
⏳ (3/3) Fetching updates (including submodules)...
✔️ fetched updates for Git repository 📂PowerShell in 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" }
$RepoDirName = (Get-Item "$RepoDir").Name
"⏳ (2/3) Checking Git repository 📂$RepoDirName... "
if (!(Test-Path "$RepoDir" -pathType container)) { throw "Can't access folder: $RepoDir" }
"⏳ (3/3) Fetching updates (including submodules)... "
& git -C "$RepoDir" fetch --all --recurse-submodules --prune --prune-tags --force
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ fetched updates for Git repository 📂$RepoDirName in $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*