PowerShell/Docs/new-branch.md

107 lines
3.5 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *new-branch.ps1* Script
2021-11-08 21:36:42 +01:00
2022-11-17 19:46:02 +01:00
This PowerShell script creates a new branch in a Git repository and switches to it.
2021-11-08 21:36:42 +01:00
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/new-branch.ps1 [[-NewBranchName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2022-11-17 19:46:02 +01:00
-NewBranchName <String>
Specifies the new branch name
2021-11-08 21:36:42 +01:00
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RepoDir <String>
2022-11-17 19:46:02 +01:00
Specifies the path to the Git repository (current working directory per default)
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> ./new-branch test123
```
## 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
Creates a new Git branch
.DESCRIPTION
This PowerShell script creates a new branch in a Git repository and switches to it.
.PARAMETER NewBranchName
Specifies the new branch name
.PARAMETER RepoDir
Specifies the path to the Git repository (current working directory per default)
.EXAMPLE
PS> ./new-branch test123
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$NewBranchName = "", [string]$RepoDir = "$PWD")
try {
2023-05-26 12:20:18 +02:00
if ($NewBranchName -eq "") { $NewBranchName = Read-Host "Enter new branch name" }
2022-11-17 20:02:26 +01:00
$StopWatch = [system.diagnostics.stopwatch]::startNew()
2023-05-26 12:20:18 +02:00
Write-Host "⏳ (1/6) Searching for Git executable... " -noNewline
2022-11-17 20:02:26 +01:00
& git --version
if ($lastExitCode -ne "0") { throw "Can't execute 'git' - make sure Git is installed and available" }
2023-05-26 12:20:18 +02:00
Write-Host "⏳ (2/6) Checking repository... 📂$RepoDir"
2022-11-17 20:02:26 +01:00
if (-not(Test-Path "$RepoDir" -pathType container)) { throw "Can't access directory: $RepoDir" }
2023-05-26 12:20:18 +02:00
$RepoDirName = (Get-Item "$RepoDir").Name
2022-11-17 20:02:26 +01:00
2023-05-26 12:20:18 +02:00
"⏳ (3/6) Fetching latest updates..."
2022-11-17 20:02:26 +01:00
& git -C "$RepoDir" fetch --all --recurse-submodules --prune --prune-tags --force
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
$CurrentBranchName = (git -C "$RepoDir" rev-parse --abbrev-ref HEAD)
if ($lastExitCode -ne "0") { throw "'git rev-parse' failed with exit code $lastExitCode" }
2023-05-26 12:20:18 +02:00
"⏳ (4/6) Creating branch..."
2022-11-17 20:02:26 +01:00
& git -C "$RepoDir" checkout -b "$NewBranchName"
if ($lastExitCode -ne "0") { throw "'git checkout -b $NewBranchName' failed with exit code $lastExitCode" }
"⏳ (5/6) Pushing updates..."
& git -C "$RepoDir" push origin "$NewBranchName"
if ($lastExitCode -ne "0") { throw "'git push origin $NewBranchName' 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
2023-05-26 12:20:18 +02:00
"✔️ created branch '$NewBranchName' in repo 📂$RepoDirName (based on '$CurrentBranchName') 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 new-branch.ps1*