mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-25 17:33:17 +01:00
130 lines
4.5 KiB
Markdown
130 lines
4.5 KiB
Markdown
Script: *switch-branch.ps1*
|
||
========================
|
||
|
||
This PowerShell script switches to the given branch in a Git repository and also updates the submodules.
|
||
|
||
Parameters
|
||
----------
|
||
```powershell
|
||
PS> ./switch-branch.ps1 [[-branchName] <String>] [[-pathToRepo] <String>] [<CommonParameters>]
|
||
|
||
-branchName <String>
|
||
Specifies the Git branch name to switch to
|
||
|
||
Required? false
|
||
Position? 1
|
||
Default value
|
||
Accept pipeline input? false
|
||
Accept wildcard characters? false
|
||
|
||
-pathToRepo <String>
|
||
Specifies the file path to the local Git repository
|
||
|
||
Required? false
|
||
Position? 2
|
||
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> ./switch-branch main
|
||
⏳ (1/6) Searching for Git executable... git version 2.43.0.windows.1
|
||
⏳ (2/6) Checking local repository... C:\Repos\rust
|
||
⏳ (3/6) Fetching remote updates...
|
||
⏳ (4/6) Switching to branch 'main'...
|
||
⏳ (5/6) Pulling remote updates...
|
||
⏳ (6/6) Updating submodules...
|
||
✔️ Switched 📂rust repo to 'main' branch in 22s.
|
||
|
||
```
|
||
|
||
Notes
|
||
-----
|
||
Author: Markus Fleschutz | License: CC0
|
||
|
||
Related Links
|
||
-------------
|
||
https://github.com/fleschutz/PowerShell
|
||
|
||
Script Content
|
||
--------------
|
||
```powershell
|
||
<#
|
||
.SYNOPSIS
|
||
Switches the Git branch
|
||
.DESCRIPTION
|
||
This PowerShell script switches to the given branch in a Git repository and also updates the submodules.
|
||
.PARAMETER branchName
|
||
Specifies the Git branch name to switch to
|
||
.PARAMETER pathToRepo
|
||
Specifies the file path to the local Git repository
|
||
.EXAMPLE
|
||
PS> ./switch-branch main
|
||
⏳ (1/6) Searching for Git executable... git version 2.43.0.windows.1
|
||
⏳ (2/6) Checking local repository... C:\Repos\rust
|
||
⏳ (3/6) Fetching remote updates...
|
||
⏳ (4/6) Switching to branch 'main'...
|
||
⏳ (5/6) Pulling remote updates...
|
||
⏳ (6/6) Updating submodules...
|
||
✔️ Switched 📂rust repo to 'main' branch in 22s.
|
||
.LINK
|
||
https://github.com/fleschutz/PowerShell
|
||
.NOTES
|
||
Author: Markus Fleschutz | License: CC0
|
||
#>
|
||
|
||
param([string]$branchName = "", [string]$pathToRepo = "$PWD")
|
||
|
||
try {
|
||
if ($branchName -eq "") { $branchName = Read-Host "Enter the branch name to switch to" }
|
||
|
||
$stopWatch = [system.diagnostics.stopwatch]::startNew()
|
||
|
||
Write-Host "⏳ (1/6) 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/6) Checking local repository... $pathToRepo"
|
||
if (-not(Test-Path "$pathToRepo" -pathType container)) { throw "Can't access repo folder: $pathToRepo" }
|
||
$result = (git -C "$pathToRepo" status)
|
||
if ($lastExitCode -ne "0") { throw "'git status' in $pathToRepo failed with exit code $lastExitCode" }
|
||
if ("$result" -notmatch "nothing to commit, working tree clean") { throw "Git repository is NOT clean: $result" }
|
||
$repoDirName = (Get-Item "$pathToRepo").Name
|
||
|
||
Write-Host "⏳ (3/6) Fetching remote updates... " -noNewline
|
||
& git -C "$pathToRepo" remote get-url origin
|
||
if ($lastExitCode -ne "0") { throw "'git remote get-url origin' failed with exit code $lastExitCode" }
|
||
|
||
& git -C "$pathToRepo" fetch --all --prune --prune-tags --force
|
||
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
|
||
|
||
"⏳ (4/6) Switching to branch '$branchName'..."
|
||
& git -C "$pathToRepo" checkout --recurse-submodules "$branchName"
|
||
if ($lastExitCode -ne "0") { throw "'git checkout $branchName' failed with exit code $lastExitCode" }
|
||
|
||
"⏳ (5/6) Pulling remote updates..."
|
||
& git -C "$pathToRepo" pull --recurse-submodules
|
||
if ($lastExitCode -ne "0") { throw "'git pull' failed with exit code $lastExitCode" }
|
||
|
||
"⏳ (6/6) Updating submodules..."
|
||
& 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
|
||
"✔️ Switched 📂$repoDirName repo to '$branchName' branch in $($elapsed)s."
|
||
exit 0 # success
|
||
} catch {
|
||
"⚠️ Error: $($Error[0]) in script line $($_.InvocationInfo.ScriptLineNumber)"
|
||
exit 1
|
||
}
|
||
```
|
||
|
||
*(generated by convert-ps2md.ps1 using the comment-based help of switch-branch.ps1 as of 08/15/2024 09:50:54)*
|