PowerShell/Docs/new-branch.md

107 lines
3.5 KiB
Markdown
Raw Normal View History

2023-07-29 09:55:25 +02:00
## Script: *new-branch.ps1*
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-07-29 09:45:37 +02:00
new-branch.ps1 [[-newBranch] <String>] [[-repoPath] <String>] [<CommonParameters>]
2021-11-08 21:36:42 +01:00
2023-07-29 09:45:37 +02:00
-newBranch <String>
2022-11-17 19:46:02 +01:00
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
2023-07-29 09:45:37 +02:00
-repoPath <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
2023-07-29 09:45:37 +02:00
PS> ./new-branch.ps1 test123
2021-11-08 21:36:42 +01:00
```
## 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
2023-07-29 09:55:25 +02:00
## Script Content
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.
2023-07-29 09:45:37 +02:00
.PARAMETER newBranch
2022-11-17 20:02:26 +01:00
Specifies the new branch name
2023-07-29 09:45:37 +02:00
.PARAMETER repoPath
2022-11-17 20:02:26 +01:00
Specifies the path to the Git repository (current working directory per default)
.EXAMPLE
2023-07-29 09:45:37 +02:00
PS> ./new-branch.ps1 test123
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
2023-07-29 09:45:37 +02:00
param([string]$newBranch = "", [string]$repoPath = "$PWD")
2022-11-17 20:02:26 +01:00
try {
2023-07-29 09:45:37 +02:00
if ($newBranch -eq "") { $newBranch = Read-Host "Enter the new branch name" }
2022-11-17 20:02:26 +01:00
2023-07-29 09:45:37 +02:00
$stopWatch = [system.diagnostics.stopwatch]::startNew()
2022-11-17 20:02:26 +01:00
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-07-29 09:45:37 +02:00
Write-Host "⏳ (2/6) Checking local repository... 📂$repoPath"
if (-not(Test-Path "$repoPath" -pathType container)) { throw "Can't access directory: $repoPath" }
$repoPathName = (Get-Item "$repoPath").Name
2022-11-17 20:02:26 +01:00
2023-05-26 12:20:18 +02:00
"⏳ (3/6) Fetching latest updates..."
2023-07-29 09:45:37 +02:00
& git -C "$repoPath" fetch --all --recurse-submodules --prune --prune-tags --force
2022-11-17 20:02:26 +01:00
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
2023-07-29 09:45:37 +02:00
$currentBranch = (git -C "$repoPath" rev-parse --abbrev-ref HEAD)
2022-11-17 20:02:26 +01:00
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..."
2023-07-29 09:45:37 +02:00
& git -C "$repoPath" checkout -b "$newBranch"
if ($lastExitCode -ne "0") { throw "'git checkout -b $newBranch' failed with exit code $lastExitCode" }
2022-11-17 20:02:26 +01:00
"⏳ (5/6) Pushing updates..."
2023-07-29 09:45:37 +02:00
& git -C "$repoPath" push origin "$newBranch"
if ($lastExitCode -ne "0") { throw "'git push origin $newBranch' failed with exit code $lastExitCode" }
2022-11-17 20:02:26 +01:00
"⏳ (6/6) Updating submodules..."
2023-07-29 09:45:37 +02:00
& git -C "$repoPath" submodule update --init --recursive
2022-11-17 20:02:26 +01:00
if ($lastExitCode -ne "0") { throw "'git submodule update' failed with exit code $lastExitCode" }
2023-07-29 09:45:37 +02:00
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ created branch '$newBranch' based on '$currentBranch' in repo 📂$repoPathName 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
2023-07-29 09:55:25 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of new-branch.ps1 as of 07/29/2023 09:55:13)*