mirror of
https://github.com/fleschutz/PowerShell.git
synced 2024-11-29 03:13:55 +01:00
132 lines
4.6 KiB
Markdown
132 lines
4.6 KiB
Markdown
The *new-branch.ps1* Script
|
|
===========================
|
|
|
|
This PowerShell script creates a new branch in a local Git repository and switches to it.
|
|
|
|
Parameters
|
|
----------
|
|
```powershell
|
|
/home/markus/Repos/PowerShell/scripts/new-branch.ps1 [[-newBranch] <String>] [[-pathToRepo] <String>] [<CommonParameters>]
|
|
|
|
-newBranch <String>
|
|
Specifies the new Git branch name
|
|
|
|
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 (current working directory per default)
|
|
|
|
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.ps1 test123
|
|
⏳ (1/6) Searching for Git executable... git version 2.45.0
|
|
⏳ (2/6) Checking local repository... C:\Repos\rust
|
|
⏳ (3/6) Fetching remote updates... git@github.org:rust/rust.git
|
|
⏳ (4/6) Creating new branch...
|
|
⏳ (5/6) Pushing updates...
|
|
⏳ (6/6) Updating submodules...
|
|
✅ Created branch 'test123' based on 'main' in 📂rust repo in 18s.
|
|
|
|
```
|
|
|
|
Notes
|
|
-----
|
|
Author: Markus Fleschutz | License: CC0
|
|
|
|
Related Links
|
|
-------------
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
Script Content
|
|
--------------
|
|
```powershell
|
|
<#
|
|
.SYNOPSIS
|
|
Creates a new Git branch
|
|
.DESCRIPTION
|
|
This PowerShell script creates a new branch in a local Git repository and switches to it.
|
|
.PARAMETER newBranch
|
|
Specifies the new Git branch name
|
|
.PARAMETER pathToRepo
|
|
Specifies the file path to the local Git repository (current working directory per default)
|
|
.EXAMPLE
|
|
PS> ./new-branch.ps1 test123
|
|
⏳ (1/6) Searching for Git executable... git version 2.45.0
|
|
⏳ (2/6) Checking local repository... C:\Repos\rust
|
|
⏳ (3/6) Fetching remote updates... git@github.org:rust/rust.git
|
|
⏳ (4/6) Creating new branch...
|
|
⏳ (5/6) Pushing updates...
|
|
⏳ (6/6) Updating submodules...
|
|
✅ Created branch 'test123' based on 'main' in 📂rust repo in 18s.
|
|
.LINK
|
|
https://github.com/fleschutz/PowerShell
|
|
.NOTES
|
|
Author: Markus Fleschutz | License: CC0
|
|
#>
|
|
|
|
param([string]$newBranch = "", [string]$pathToRepo = "$PWD")
|
|
|
|
try {
|
|
if ($newBranch -eq "") { $newBranch = Read-Host "Enter the new Git branch name" }
|
|
|
|
$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" }
|
|
$repoName = (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 --recurse-submodules --prune --prune-tags --force
|
|
if ($lastExitCode -ne "0") { throw "'git fetch' failed with exit code $lastExitCode" }
|
|
|
|
$currentBranch = (git -C "$pathToRepo" rev-parse --abbrev-ref HEAD)
|
|
if ($lastExitCode -ne "0") { throw "'git rev-parse' failed with exit code $lastExitCode" }
|
|
|
|
"⏳ (4/6) Creating new branch..."
|
|
& git -C "$pathToRepo" checkout -b "$newBranch"
|
|
if ($lastExitCode -ne "0") { throw "'git checkout -b $newBranch' failed with exit code $lastExitCode" }
|
|
|
|
"⏳ (5/6) Pushing updates..."
|
|
& git -C "$pathToRepo" push origin "$newBranch"
|
|
if ($lastExitCode -ne "0") { throw "'git push origin $newBranch' 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
|
|
"✅ Created branch '$newBranch' based on '$currentBranch' in 📂$repoName repo in $($elapsed)s."
|
|
exit 0 # success
|
|
} catch {
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
|
exit 1
|
|
}
|
|
```
|
|
|
|
*(generated by convert-ps2md.ps1 as of 11/08/2024 12:40:19)*
|