1
0
mirror of https://github.com/fleschutz/PowerShell.git synced 2024-12-16 19:50:45 +01:00
PowerShell/Docs/switch-branch.md

110 lines
3.6 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *switch-branch.ps1* Script
2021-11-08 21:36:42 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script switches to another branch in a Git repository (including submodules).
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2021-12-09 16:19:09 +01:00
switch-branch.ps1 [[-BranchName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
-BranchName <String>
Specifies the branch name
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RepoDir <String>
2022-12-04 10:40:18 +01:00
Specifies the path to the local Git repository
2021-11-08 21:36:42 +01:00
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 C:\MyRepo
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-11-08 21:36:42 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Switches the Git branch
.DESCRIPTION
This PowerShell script switches to another branch in a Git repository (including submodules).
.PARAMETER BranchName
Specifies the branch name
.PARAMETER RepoDir
2022-12-04 10:40:18 +01:00
Specifies the path to the local Git repository
2022-11-17 20:02:26 +01:00
.EXAMPLE
PS> ./switch-branch main C:\MyRepo
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$BranchName = "", [string]$RepoDir = "$PWD")
try {
if ($BranchName -eq "") { $BranchName = read-host "Enter name of branch to switch to" }
2022-12-04 10:40:18 +01:00
if ($RepoDir -eq "") { $RepoDir = read-host "Enter path to the local Git repository" }
2022-11-17 20:02:26 +01:00
$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" }
$RepoDir = Resolve-Path "$RepoDir"
$RepoDirName = (Get-Item "$RepoDir").Name
2022-12-04 10:40:18 +01:00
"⏳ (2/6) Checking Git repository 📂$RepoDirName..."
2022-11-17 20:02:26 +01:00
if (-not(Test-Path "$RepoDir" -pathType container)) { throw "Can't access directory: $RepoDir" }
$Result = (git status)
if ($lastExitCode -ne "0") { throw "'git status' in $RepoDir failed with exit code $lastExitCode" }
if ("$Result" -notmatch "nothing to commit, working tree clean") { throw "Git repository is NOT clean: $Result" }
"⏳ (3/6) Fetching updates..."
& git -C "$RepoDir" fetch --all --prune --prune-tags --force
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
2022-12-04 10:40:18 +01:00
"⏳ (4/6) Switching to '$BranchName' branch..."
2022-11-17 20:02:26 +01:00
& git -C "$RepoDir" checkout --recurse-submodules "$BranchName"
if ($lastExitCode -ne "0") { throw "'git checkout $BranchName' failed with exit code $lastExitCode" }
"⏳ (5/6) Pulling updates..."
& git -C "$RepoDir" pull --recurse-submodules
if ($lastExitCode -ne "0") { throw "'git pull' failed with exit code $lastExitCode" }
"⏳ (6/6) Updating submodules..."
& git -C "$RepoDir" submodule update --init --recursive
if ($lastExitCode -ne "0") { throw "'git submodule update' failed with exit code $lastExitCode" }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
2022-12-04 10:40:18 +01:00
"✔️ switched Git repository 📂$RepoDirName to $BranchName branch in $Elapsed sec."
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
2021-11-08 21:36:42 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of switch-branch.ps1*