extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-08-16 07:38:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated the Markdown manuals

Browse Source
This commit is contained in:
Markus Fleschutz
2024-05-19 10:25:56 +02:00
parent c24030c909
commit 439fbf5bfa
621 changed files with 2430 additions and 1289 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/pull-repo.md
View File

@ -1,14 +1,14 @@
Script: *pull-repo.ps1*
========================
This PowerShell script pulls the latest updates into a local Git repository (including submodules).
This PowerShell script pulls remote updates into a local Git repository (including submodules).
Parameters
----------
```powershell
PS> ./pull-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
PS> ./pull-repo.ps1 [[-pathToRepo] <String>] [<CommonParameters>]
-RepoDir <String>
-pathToRepo <String>
Specifies the file path to the local Git repository (default is working directory)
Required? false
@ -25,12 +25,12 @@ PS> ./pull-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
Example
-------
```powershell
PS> ./pull-repo.ps1 C:\MyRepo
⏳ (1/4) Searching for Git executable... git version 2.42.0.windows.1
⏳ (2/4) Checking local repository...
⏳ (3/4) Pulling updates...
PS> ./pull-repo.ps1
⏳ (1/4) Searching for Git executable... git version 2.44.0.windows.1
⏳ (2/4) Checking local repository... 📂C:\Repos\rust
⏳ (3/4) Pulling remote updates...
⏳ (4/4) Updating submodules...
✔️ Pulled updates into repo 📂MyRepo in 14 sec
✔️ Updates pulled into 📂rust repo in 14s.
```
@ -47,49 +47,49 @@ Script Content
```powershell
<#
.SYNOPSIS
Pulls updates into a Git repository
Pulls updates into a Git repo
.DESCRIPTION
This PowerShell script pulls the latest updates into a local Git repository (including submodules).
.PARAMETER RepoDir
This PowerShell script pulls remote updates into a local Git repository (including submodules).
.PARAMETER pathToRepo
Specifies the file path to the local Git repository (default is working directory)
.EXAMPLE
PS> ./pull-repo.ps1 C:\MyRepo
⏳ (1/4) Searching for Git executable... git version 2.42.0.windows.1
⏳ (2/4) Checking local repository...
⏳ (3/4) Pulling updates...
PS> ./pull-repo.ps1
⏳ (1/4) Searching for Git executable... git version 2.44.0.windows.1
⏳ (2/4) Checking local repository... 📂C:\Repos\rust
⏳ (3/4) Pulling remote updates...
⏳ (4/4) Updating submodules...
✔️ Pulled updates into repo 📂MyRepo in 14 sec
✔️ Updates pulled into 📂rust repo in 14s.
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$RepoDir = "$PWD")
param([string]$pathToRepo = "$PWD")
try {
$StopWatch = [system.diagnostics.stopwatch]::startNew()
$stopWatch = [system.diagnostics.stopwatch]::startNew()
Write-Host "⏳ (1/4) 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/4) Checking local repository..."
if (-not(Test-Path "$RepoDir" -pathType container)) { throw "Can't access folder: $RepoDir" }
$Result = (git -C "$RepoDir" status)
if ("$Result" -match "HEAD detached at ") { throw "Currently in detached HEAD state (not on a branch!), so nothing to pull" }
$RepoDirName = (Get-Item "$RepoDir").Name
Write-Host "⏳ (2/4) Checking local repository... 📂$pathToRepo"
if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access folder: $pathToRepo" }
$result = (git -C "$pathToRepo" status)
if ("$result" -match "HEAD detached at ") { throw "Nothing to pull due to detached HEAD state (not on a branch!)" }
$pathToRepoName = (Get-Item "$pathToRepo").Name
Write-Host "⏳ (3/4) Pulling updates..."
& git -C "$RepoDir" pull --recurse-submodules=yes
Write-Host "⏳ (3/4) Pulling remote updates..."
& git -C "$pathToRepo" pull --recurse-submodules=yes
if ($lastExitCode -ne "0") { throw "'git pull' failed with exit code $lastExitCode" }
Write-Host "⏳ (4/4) Updating submodules... "
& git -C "$RepoDir" submodule update --init --recursive
& git -C "$pathToRepo" submodule update --init --recursive
if ($lastExitCode -ne "0") { throw "'git submodule update' failed with exit code $lastExitCode" }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ Pulled updates into repo 📂$RepoDirName in $Elapsed sec"
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Updates pulled into 📂$pathToRepoName repo in $($elapsed)s."
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -97,4 +97,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of pull-repo.ps1 as of 03/27/2024 17:36:31)*
*(generated by convert-ps2md.ps1 using the comment-based help of pull-repo.ps1 as of 05/19/2024 10:25:25)*